{
"type": "contact.unsubscribed",
"webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
"timestamp": "2026-10-21T10:15:00Z",
"data": {
"account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
"origin": "recipient",
"campaign_id": "3af77d52-096f-42a2-8cc7-b6eccdccff8e",
"contact": {
"object": "contact",
"id": "e43e4167-f186-4a7f-9b6e-ac9fdc6426e1",
"created_at": "2026-09-21T10:15:00Z",
"updated_at": "2026-10-21T10:15:00Z",
"email": "someone@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"status": "enabled",
"status_reason": "",
"unsubscribed": false,
"unsubscribed_at": null,
"attributes": {
"plan": "pro"
},
"validation_status": "valid",
"last_validated_at": "2026-10-20T10:15:00Z"
},
"list": {
"id": "8b5a3112-8fa1-4bde-9c20-8af76484daf4",
"name": "Newsletter"
},
"list_contact": {
"object": "list_contact",
"list_id": "8b5a3112-8fa1-4bde-9c20-8af76484daf4",
"contact_id": "e43e4167-f186-4a7f-9b6e-ac9fdc6426e1",
"email": "someone@example.com",
"subscription_status": "unsubscribed",
"subscribed_at": "2026-09-21T10:15:00Z",
"unsubscribed_at": "2026-10-21T10:15:00Z",
"created_at": "2026-09-21T10:15:00Z",
"updated_at": "2026-10-21T10:15:00Z"
},
"previous_subscription_status": "confirmed"
}
}Contact Events
contact.unsubscribed Webhook Event
The contact.unsubscribed webhook fires when an AhaSend contact unsubscribes from a list or from all lists, for example through a campaign’s link.
WEBHOOK
contact.unsubscribed
{
"type": "contact.unsubscribed",
"webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
"timestamp": "2026-10-21T10:15:00Z",
"data": {
"account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
"origin": "recipient",
"campaign_id": "3af77d52-096f-42a2-8cc7-b6eccdccff8e",
"contact": {
"object": "contact",
"id": "e43e4167-f186-4a7f-9b6e-ac9fdc6426e1",
"created_at": "2026-09-21T10:15:00Z",
"updated_at": "2026-10-21T10:15:00Z",
"email": "someone@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"status": "enabled",
"status_reason": "",
"unsubscribed": false,
"unsubscribed_at": null,
"attributes": {
"plan": "pro"
},
"validation_status": "valid",
"last_validated_at": "2026-10-20T10:15:00Z"
},
"list": {
"id": "8b5a3112-8fa1-4bde-9c20-8af76484daf4",
"name": "Newsletter"
},
"list_contact": {
"object": "list_contact",
"list_id": "8b5a3112-8fa1-4bde-9c20-8af76484daf4",
"contact_id": "e43e4167-f186-4a7f-9b6e-ac9fdc6426e1",
"email": "someone@example.com",
"subscription_status": "unsubscribed",
"subscribed_at": "2026-09-21T10:15:00Z",
"unsubscribed_at": "2026-10-21T10:15:00Z",
"created_at": "2026-09-21T10:15:00Z",
"updated_at": "2026-10-21T10:15:00Z"
},
"previous_subscription_status": "confirmed"
}
}AhaSend sends this event when a membership’s subscription status becomes
unsubscribed, or when the contact’s unsubscribe from all lists is set (unsubscribed changes to true).
A recipient who unsubscribes from a campaign email sends this event with origin: recipient and the data.campaign_id of the campaign. The campaign email also sends its own message.unsubscribed. For a membership, data.previous_subscription_status is the status before the change. For the unsubscribe from all lists, data.list and data.list_contact are null.
A recipient of a campaign sent to a segment unsubscribes from all lists, so the event has data.list and data.list_contact set to null, and data.segment_id is the segment.
No event:
- An unsubscribe of a membership or a contact that is already unsubscribed
- A change of a membership’s status to
unconfirmed - A new membership, which sends
contact.added_to_list, and a new contact, which sendscontact.created
on_contact_unsubscribed (Contact Unsubscribed in the dashboard).
Requirements:
- Your account has the marketing features. Contact events cannot be turned on without them.
- A webhook with this event on needs an API key with
contacts:readandlists:readwhen you create or update it through the API. See contact events.
Related Guides
- API authentication, Permission scopes, Webhook setup.
- Event reference, Webhook CLI, Local webhook testing.
- Signature verification, Retry policy, API errors.
- API rate limits, Contacts API, Lists API.
Body
application/json
The event type
Available options:
contact.unsubscribed The webhook ID (the same ID as returned by the Create Webhook API)
When the change happened (ISO 8601 format)
Show child attributes
Show child attributes
Response
Webhook received successfully