Subscribers

Unsubscribe

Permission required: subscribers:write.

Does not erase the record: the person moves to unsubscribed and their address enters the suppression list. Erasing the trace would bring the address back at the next file import. The person no longer receives your campaigns, your automations, or sends carrying unsubscribe_url; your individual emails still reach them.

delete/api/v1/subscribers/{email}

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/subscribers/{email}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

emailstring email required

The address, URL-encoded.

Response

Unsubscribed.

object'subscriber'
emailstring
status'unsubscribed'
suppressedboolean
deletedfalse

Always false: the record is kept.

Changes

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