Sign in
Customers

Unsubscribe a customer from campaigns and triggers

post/customers/{id}/unsubscribe

Path parameters

idstring required

The ID of the customer

Request body

OR
OR
OR

Response

The Customer object which was unsubscribed

idstring required

The ID of the customer

external_idstring nullable required

The external ID of the customer

email_addressstring nullable required

The email address of the customer

phone_numberstring nullable required

The phone number of the customer

full_namestring nullable required

The full name of the customer

metadataobject required

The metadata associated with this customer

unsubscribed'future' | 'campaign' nullable required

The unsubscribe status of the customer

Changes

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