Suppression

Add to suppression list

Add an email to the workspace suppression list. Provide an email directly, or a contact_id that resolves to its email within the key's workspace. Upserts on (workspace_id, email). Requires the suppression.write scope.

post/suppression

Request

  • Base URL: https://www.sagaris.ai/api/v1
  • URL: https://www.sagaris.ai/api/v1/suppression
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Opaque client-supplied key. A retry with the same key replays the original response instead of writing again.

Request body

emailstring email
contact_idstring

A contact in the key's workspace; resolves to its email.

reasonstring

Suppression reason; defaults to manual.

Response

The suppression row.

errorunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.