Unsubscribes

An unsubscribe event occurs when a recipient either clicks the unsubscribe link provided in your content or the unsubscribe button provided by some Email Service Providers.

List of Body Attributes

This table shows the list of parameters present in the payload and their explanations.

Parameters	Data Type	Description
webhook_name	String	Name of the webhook you configured.
webhook_id	String	ID of the configured webhook.
action	String	Name of the event.
actionType	String	Name of the event.
action_by	String	Indicates by whom the action was made.
action_time	Long	Time at which the unsubscribe event happened.
contact_id	Long	ID of the contact who unsubscribed.
contact_email	String	Email address of the contact unsubscribed.
data	JSON Array	An array of data about the events.
rcpt_additional_data	JSON Object	Additional data of the recipient that was provided by you in Transmission API or Recipient List API.
transmission_name	String	The name you provided for the transmission in Transmission API.
injected_time	Long	The time the transmission was created.
transmission_id	Long	The ID of the transmission.
zuid	Long	The ID of the user that sent the transmission API request.

Sample payload for an unsubscribe event

Copied{
  "webhook_name": "Unsubscribe webhook",
  "webhook_id": "1314909000000063006",
  "action": "unsubscribed",
  "actionType": "doNotMail",
  "action_by": "contact",
  "data": [
    {
      "action_time": 1725461219974,
      "contact_id": 1314909000000144100,
      "contact_email": "john.doe@zylker.com",
      "rcpt_additional_data": {
        "country": "JP",
        "Phone": "1239333320"
      },
      "transmission_name": "My first Email API Campaign",
      "injected_time": 1725543431000,
      "transmission_id": 13149090000001440022131,
      "zuid": 8575431221455
    }
  ]
}