opensend.cc
GitHub
Skip to documentation

API · Suppressions

Remove Batch Suppressions

Remove 1–100 suppressions by email address or ID (requires full access). The request is atomic; a missing or inaccessible entry rejects the whole batch.

POST/suppressions/batch/removeFull access

Request parameters

ParameterTypeDescription
Idempotency-Key
header · optional
string
1–256 characters
Makes the request safe to retry. See Idempotency.
emails
body · optional
(string)[]
1–100 items
Email addresses to remove from the suppression list.
ids
body · optional
(string)[]
1–100 items
Suppression IDs to remove from the suppression list.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X POST "$OPENSEND_BASE_URL/suppressions/batch/remove" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"emails":["you@example.net"]}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "data": [
    {
      "object": "suppression",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "deleted": true
    }
  ]
}

Behavior and errors

Batches accept 1–100 entries and commit atomically. Removal requires exactly one of emails or ids; a missing or foreign entry refuses the entire batch. Results follow input order.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.