Skip to content

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

curl https://api.useinfrared.com/v1/authors/user_4821/suspend \
  -H "Authorization: Bearer $INFRARED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Promotional reviews for another shop",
    "until": "2026-10-15T00:00:00Z"
  }'
200 OKResponse
{
  "object": "author",
  "id": "aut_7ZRftUOZyMjsmFWvJifaOJ",
  "project_id": "prj_0TBAgHGtdMketrbltGFHuk",
  "external_id": "user_4821",
  "display_name": "Maya Okafor",
  "status": "suspended",
  "status_reason": "Promotional reviews for another shop",
  "status_until": "2026-10-15T00:00:00.000Z",
  "trust_level": "new",
  "trust_level_automatic": "new",
  "trust_override": null,
  "risk_score": 1,
  "stats": {
    "moderations": 5,
    "flagged": 5,
    "rejected": 5,
    "reviewed": 0,
    "reports": 0
  },
  "first_seen_at": "2026-10-08T08:50:58.962Z",
  "last_seen_at": "2026-10-08T09:28:46.195Z",
  "metadata": {
    "country": "GB",
    "email_verified": true
  },
  "created_at": "2026-10-08T08:50:59.118Z",
  "updated_at": "2026-10-08T09:29:21.179Z"
}

Path parameters

external_idstringRequired

Your id for the end user. The author must exist: this call does not create one.

Request body

reasonstring

Why 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 as status_reason and sent in the author.suspended event. Omitted or null clears a reason stored earlier.

untiltimestamp

When the suspension ends. ISO 8601 in UTC with a trailing Z, for example 2026-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.

Errors

404
not_found

The project has no author with this id.

422
validation_error

The body has an unknown key, reason is longer than 500 characters, or until is not ISO 8601 in UTC with a trailing Z.

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.