API · suppressions

Add suppression

POST /api/v2/suppressions

Authorization

Owner/admin user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

Name	Type	Contract
recipient	string · required	Email address up to 254 characters

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example

inboxit suppressions add --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example

{
  "recipient": "recipient@example.com"
}

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example

{
  "suppressed": true
}

Behavior & errors

Adds an account-wide manual suppression. No customer unsuppress endpoint exists. Applies across owner workspaces. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.