Platform · Email
Email Suppressions
Everybody who pressed Unsubscribe in an email, or was unsubscribed for them. An address here is sent nothing by any company in this system, except a message the person asks for themself to get into their own account. Re-subscribing one needs a reason, and is audited.
/api/platform/email-suppressionsDownload specification (OpenAPI 3.1) Screen: Email Suppressions
Overview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Email Suppressions on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
5 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/email-suppressions/summarySummary
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/email-suppressions/summary" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/email-suppressionsRead email suppressions
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/email-suppressions" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/email-suppressions/{id}Read email suppressions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/email-suppressions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/email-suppressionsPost email suppressions
Request body
The keys this action reads (* = required; "one of" lists the only values):
address, reason, sourceResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/email-suppressions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"address":"value","reason":"value","source":"value"}'POST/api/platform/email-suppressions/{id}/resubscribeResubscribe
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/email-suppressions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resubscribe" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Email Suppressions for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.