Suppressions

Lift a suppression

POST/v1/suppressions/delete

TypeScript sendora.suppressions.delete({ address })

Python sendora.suppressions.delete(address=...)

Key sk_… a server key

Removes a hard-bounced or manually added address from a stream’s list so the server may send to it again on that stream. A POST, because the address travels in the body and never in a URL. A spam complaint cannot be lifted this way.

Request body

addressstring (email)required
The address to send to again.
streamIdstring (uuid)
The stream whose list is meant; the default transactional stream when absent.

{
  "address": "anna@example.com"
}

Responses

`204`Removed. The body is empty.

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

Code	Status	Meaning
`invalid_request`	400	The body, the query or a header does not match what the route takes.
`unauthorized`	401	The key is missing, malformed or revoked.
`wrong_token_kind`	403	The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.
`spam_complaint_locked`	403	The recipient reported a message as spam; only Sendora support lifts that, at the recipient’s own request.
`unsubscribe_locked`	403	The recipient unsubscribed themselves; only Sendora support lifts that, at the recipient’s own request.
`not_found`	404	No such suppressed address of this server.
`stream_not_found`	422	The streamId names no stream of this server.
`stream_not_sendable`	422	An inbound stream receives mail; it takes no messages and has no suppression list. Name a transactional or broadcast stream.

`invalid_request`

issuesarray of object
One entry per invalid field; absent when a header is wrong.
- pathstringrequired
  The field, dotted, such as to.0.email; empty when the whole body is wrong.
- messagestringrequired

Example

{
  "error": "invalid_request",
  "message": "The request is invalid: to.0: Invalid email address",
  "issues": [
    {
      "path": "to.0",
      "message": "Invalid email address"
    }
  ]
}