Suspend an author
POST/v1/authors/{external_id}/suspendKey scope write
Sets the author's status to suspended, until a date or until the author is enabled again. A suspension past its end date already reads as enabled in decisions; the stored status follows within 15 minutes, and the author.enabled event is emitted then.
Needs a key with the write scope. Authentication
Path parameters
external_idstringRequiredYour id for the end user. The author must exist: this call does not create one.
Request body
reasonstringWhy the author is suspended. Keep it to 255 characters: validation accepts up to 500, and a reason longer than 255 answers 500
internal_error. Stored asstatus_reasonand sent in theauthor.suspendedevent. Omitted or null clears a reason stored earlier.untiltimestampWhen the suspension ends. ISO 8601 in UTC with a trailing
Z, for example2026-11-01T00:00:00Z. Without it the suspension has no end date.
Returns
The author. The author.suspended event is emitted when the status changed.
- 200 OKAn author object
Errors
- 404
not_foundThe project has no author with this id.
- 422
validation_errorThe body has an unknown key,
reasonis longer than 500 characters, oruntilis not ISO 8601 in UTC with a trailingZ.
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.