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

Either external ID or the ID assigned by moderation API.

Body

application/json
reason
string

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

duration
number

How long the suspension lasts, in milliseconds. Defaults to 24 hours.

Required range: x >= 0

Response

Action executed successfully

Execution result

success
boolean
required

Whether the action was executed successfully