Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Project-Id
string

The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.

Path Parameters

id
string
required

The content ID you sent when you submitted the content, or the ID Moderation API assigned.

Body

application/json
reason
string

Why the action was taken. Saved with the action and sent in the webhook event.

queueId
string

The queue the content is reviewed in. Defaults to the project's default queue.

moderator
string

The user ID or email of the organization member who made the decision. The action is recorded as theirs.

createCasebookCase
boolean

Record an allow or reject decision as a casebook case. Defaults to true when moderator is set, else false. Without moderator, the case is recorded as System.

Response

Action executed successfully

Execution result

success
boolean
required

Whether the action was executed successfully