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

Body

application/json
​
emails
string<email>[]
required

Required. Array of email addresses to unsubscribe.

Required array length: 1 - 1000 elements

Required. Email address must be valid with max 255 characters.

Maximum string length: 255
​
reason
string | null

Optional. Reason for unsubscribing.

Maximum string length: 255

Response

​
ok
boolean
required
​
count
string
required