API referenceSuppressions
Suppress an address
Marketing is never sent to it. An address suppressed already keeps its first reason.
POST
Marketing is never sent to it. An address suppressed already keeps its first reason.
idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255application/json- body
address*stringFormat
emailreason?stringDefault
"manual"Value in
"manual""invalid"note?|Length
length <= 500Created
application/json- response
id*stringFormat
uuidaddress*stringreason*stringValue in
"hard_bounce""spam_complaint""soft_bounces""invalid""manual"messageId*|Format
uuiddetail*string|nulladdedBy*string|nullcreatedAt*stringFormat
date-timecurl -X POST 'https://api.postforge.dev/v1/suppressions' \ -H 'Content-Type: application/json' \ -d '{ "address": "user@example.com"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "address": "string", "reason": "hard_bounce", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "detail": "string", "addedBy": "string", "createdAt": "2019-08-24T14:15:22Z"}