Unsubscribe Contact

Unsubscribe an existing contact in your workspace. The contact path parameter accepts either the contact UUID or the current workspace identity value.

Idempotent Behavior

What happens when the contact is already unsubscribed

  • If the contact is already unsubscribed, the endpoint still returns 200 with the current contact record.
  • Pass the contact UUID or the workspace identity value to resolve the contact.
  • Email identity lookups are normalized before matching, so casing does not affect the lookup.
  • The resolved contact must belong to the workspace in the path.
POST
/v1/workspaces/:workspace/contacts/:contact/unsubscribe

Unsubscribe a contact by UUID or identity value

Path parameters

workspacestring Required

ID of your workspace

contactstring Required

Contact UUID or the current workspace identity value

Unsubscribe by UUID
curl -X POST https://api.leadpush.io/v1/workspaces/:workspace/contacts/:contact/unsubscribe \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
Unsubscribe by Identity
curl -X POST https://api.leadpush.io/v1/workspaces/:workspace/contacts/person@example.com/unsubscribe \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
Response Example
{
"data": {
  "uuid": "<contact_uuid>",
  "subscribed": false,
  "attributes": {
    "email": "person@example.com",
    "phone": "+1234567890",
    "first_name": "John",
    "last_name": "Doe"
  },
  "provider": "gmail",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "created_at": "2021-01-01T00:00:00.000Z"
}
}