Create suppressions
Adds up to 1000 addresses to a suppression list. key defaults to the workspace-wide * list and scope to all; a scope of optional blocks only sends marked as unsubscribable, so a marketing opt-out does not stop a password reset. Adding an address that is already listed updates the existing entry rather than duplicating it, and never narrows a wider scope. space_id puts the entries on a space’s list, which stops that space’s sends alone; without it they stop every space’s.
POST
/suppressionsAuthorization
AuthorizationBearer token (API key) · headerrequiredPass an AI Inbx API key as a Bearer token.
Request body
requiredapplication/jsonaddressesstring<email>[]requiredmin items 1 · max items 1000
keystringmin length 1 · max length 256 · default: "*"
space_idstringWhich space a created resource goes in. Omitted, the workspace itself.
matches ^[a-z]+_[0-9a-f]{32}$
scopestringdefault: "all"
Allowed:
alloptionalnotestringmax length 1000
Responses
201The suppressions were created or updated.
dataobject[]requiredShow propertiesHide properties
Array of
objectidstringrequiredmatches ^[a-z]+_[0-9a-f]{32}$
addressstring<email>requiredmatches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
keystringrequiredspace_idstring | anyrequiredWhich space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.
Show propertiesHide properties
Any of:
string
stringany
anyreasonstringrequiredAllowed:
complaintbounceunsubscribemanualscopestringrequiredAllowed:
alloptionalnotestring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anyblocksintegerrequiredmin 0 · max 9007199254740991
last_blocked_atstring<date-time> | anyrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anysource_email_idstring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anycreated_atstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
400The request is invalid.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired401The API key is missing or invalid.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired403The API key does not have the required scope.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired404The requested resource does not exist.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired409The request conflicts with the resource's current state.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired413The request body or attachments are too large.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired415The request body is not JSON.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired422The request body failed validation.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired429The organisation's request budget is spent (`too_many_requests`), or an upstream mail provider is throttling (`rate_limited`).
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired500An internal error occurred.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired502An upstream mail provider failed.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired503The service is temporarily unavailable.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired