Resolve a queue item
POST/v1/queue/{id}/resolveKey scope write
Resolves a review queue item by executing an action on its moderation: allow, reject or an action of your own. Send resolution for the two built-in outcomes, or action for any action key. The item is resolved only when the action's queue_behavior is resolve: an action that keeps the queue as it is, such as block_author, runs and leaves the item open.
Needs a key with the write scope. Authentication
Path parameters
idstringRequiredId of the queue item:
qi_plus 22 base62 characters.
Request body
resolutionenumallowedruns the built-inallowaction andrejectedrunsreject. Required unlessactionis sent.One of
allowedrejectedactionstringKey of the action to execute, up to 64 characters, for example
rejector the key of a custom action. Required unlessresolutionis sent. When both are sent,actionis used.valueanyA value passed to the action, of any JSON type. Only actions with
accepts_valueset to true take one, so it cannot be sent withallowedorrejected. The built-inblock_authorandsuspend_authorread a reason string, or an object withreasonanduntil.notestringA note of up to 4,000 characters, stored on the queue item and in the action log.
Returns
The queue item. After a resolving action its state is resolved and its resolution is allowed, rejected or action:<key>, and the matching queue_item.* event and action.executed are emitted. An item that was already resolved is returned unchanged.
- 200 OKA queue item object
Errors
- 404
not_foundThe key's project has no queue item with this id.
- 409
action_disabledThe action is disabled.
- 422
validation_errorNeither
resolutionnoractionwas sent, the action key is unknown,valuewas sent to an action that does not accept one, or an author action was used on a moderation that has no author.
Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors
Something missing or unclear on this page? Write to support@useinfrared.com.