Client API: Mail: Suppressions
The 3 Client API operations for suppressions.
Part of Mail.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/platform-mail/{tenant_id}/suppressions |
List suppressions |
| POST | /api/v1/client/platform-mail/{tenant_id}/suppressions |
Add suppression |
| DELETE | /api/v1/client/platform-mail/{tenant_id}/suppressions/{suppression_id} |
Remove suppression |
List suppressions
Section titled List suppressionsGET /api/v1/client/platform-mail/{tenant_id}/suppressions
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
tenant_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Add suppression
Section titled Add suppressionPOST /api/v1/client/platform-mail/{tenant_id}/suppressions
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
tenant_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
address |
string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Remove suppression
Section titled Remove suppressionDELETE /api/v1/client/platform-mail/{tenant_id}/suppressions/{suppression_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
suppression_id |
path | integer | yes |
tenant_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |