Mailing lists

Unsubscribe contacts from a mailing list

Moves specified email addresses to the unsubscribed state within a given list.

post/addressbooks/{id}/emails/unsubscribe

Request

  • Base URL: https://api.sendpulse.com
  • URL: https://api.sendpulse.com/addressbooks/{id}/emails/unsubscribe
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.sendpulse.com/oauth/access_token)

Request body

emailsstring[] required

Example request

{
  "emails": [
    "user@example.com"
  ]
}

Response

Contacts successfully unsubscribed

resultboolean

Changes

No recorded changes to this operation across all 1 revision of this API.