Suppressions
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
The addresses this workspace will not send to: hard bounces and complaints, recorded as they happen, and any address somebody blocks by hand. A send to one is refused for that recipient before anything leaves. A hard bounce stays for good; a complaint or a manual entry can be removed. Reading needs settings:read and changing needs settings:write, the scopes the Blocked addresses screen in Settings is gated on.
GET/suppressions
List suppressed addresses
The addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand. It is the Blocked addresses screen in Settings. A send to a suppressed address is refused for that recipient before anything leaves, and a message whose recipients are all suppressed fails outright.
The list belongs to the whole workspace, so a key limited to particular addresses or domains reads all of it. A row names the recipient and never which of your addresses sent to it.
Requires the settings:read scope.
Paramètres de requête
qstringSearches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
Jusqu'à 320 caractèresreasonstringKeeps one kind.
L'un de"bounce""complaint""manual"limitintegerRows per page, 1 to 100.
Au moins 1Au plus 100Par défaut25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
Retourne
A page of the suppression list, newest first.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
POST/suppressions
Add a suppressed address
Puts an address on the list by hand, with reason: "manual", so no address in the workspace sends to it until it is removed. Adding one that is already there changes nothing and answers 200 with the row it already holds, whatever its reason. A new entry fires suppression.added.
The list stops mail from every address in the workspace, so a key limited to particular addresses or domains, and an app connected by anybody but the owner, cannot change it.
Requires the settings:write scope.
Corps de la requête
emailstringObligatoireThe address to stop sending to. Trimmed and lower-cased on the way in.
Jusqu'à 320 caractèresFormatemail
Retourne
It was already on the list. The row that was there, unchanged.
Added. Nothing is sent to the address from here on.
Erreurs
- 422
invalid_parameterfor an address that is not one, orcapability_unsupportedfor a key limited to particular addresses or domains.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
GET/suppressions/{id}
Retrieve a suppressed address
One row of the suppression list.
Requires the settings:read scope.
Paramètres de chemin
idstringObligatoireThe id from
GET /suppressions.
Retourne
The row.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
DELETE/suppressions/{id}
Remove a suppressed address
Takes an address off the list, so mail may go to it again. It is Allow again on the Blocked addresses screen, and it fires suppression.removed. Only a complaint or a manual entry can be removed.
Requires the settings:write scope.
Paramètres de chemin
idstringObligatoireThe id from
GET /suppressions.
Retourne
Removed. Mail may go to the address again.
objectstring- L'un de
"suppression" idstringemailstringdeletedboolean- L'un de
true
Erreurs
- 409
suppression_not_removable: the address bounced hard, so it stays. Check the address is right and send to the corrected one.- 422
capability_unsupportedfor a key limited to particular addresses or domains.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
Objets
Suppressionobject
objectstring- L'un de
"suppression" idstringemailstringThe recipient address, lower-cased. It is somebody you sent to, not one of your own.
reasonstringbounceis a hard bounce and stays for good.complaintmeans the recipient marked a message as spam.manualmeans somebody added it.L'un de"bounce""complaint""manual"detailstringWhat the bounce or complaint said, when it said anything.
Peut être nullremovablebooleanWhether
DELETE /suppressions/{id}will take it off. False for a bounce.createdAtstring- Format
date-time
SuppressionListobject
objectstring- L'un de
"list" dataSuppression[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Peut être null