Skip to main content
POST
/
email
/
contacts
/
unsubscribe
Unsubscribe a single email contact
curl --request POST \
  --url http://localhost/public/v1/email/contacts/unsubscribe \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "reason": "<string>"
}
'
{
  "ok": true,
  "email": "<string>",
  "unsubscribed_at": "<string>",
  "reason": "<string>"
}

Body

application/json
email
string<email>
required

Required. Email address to unsubscribe.

Maximum string length: 255
reason
string | null

Optional. Reason for unsubscribing.

Maximum string length: 255

Response

ok
boolean
required
email
string
required
unsubscribed_at
string
required
reason
string
required