POpocketflows
Customers

Unsubscribe a customer from campaigns and triggers

Changed on
post/customers/{id}/unsubscribe

Request

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

first_namestring nullable required

The first name of the customer

last_namestring nullable required

The last name of the customer

metadataobject required

The metadata associated with this customer

unsubscribed'future' | 'campaign' nullable required

The unsubscribe status of the customer

Changes

  • a8a7fb59cefcRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status