POST
/suppressionsPOST /suppressions
Suppress an address by hand.
Request
curl -X POST 'https://api.sendheron.com/api/v1/suppressions' \
-H 'Authorization: Bearer <YOUR_API_KEY>' \
-H 'Content-Type: application/json'Required scopes
The key must carry these:
- suppressions:write
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | Address to suppress. | |
| reason | manual | admin | No | Defaults to manual. Only these two are accepted: bounce and complaint are provider-reported facts the platform records for itself. |
| note | string | No | Up to 1000 characters, shown to support. |
Responses
Returns 201 on success.
- 400
- The payload failed validation, or the request is not valid for the current state.
- 401
- Missing or invalid API key.
- 403
- Valid key, but it does not carry the required scope.
- 404
- No such record in this workspace.
- 409
- A duplicate, or an idempotency key reused with a different payload.
- 429
- Either rate-limit ceiling was exceeded.
Rate limits
100/min per key, counted against the organization's WRITE ceiling (400/min). Both windows are one minute. There is no hourly or daily quota.