Unsubscribe customer

Mark a customer as unsubscribed. Contendar stops sending them NPS and testimonial invites.

POST /customers/{customerId}/unsubscribe

The unsubscribe time is set once. Calling this again on a customer who is already unsubscribed keeps the first time and returns the customer unchanged.

Authentication

Send your API key as a bearer token. See Authentication .

Path parameters

Parameter	Type	Notes
`customerId`	UUID	The ID of the customer.

Request body

Field	Type	Required	Notes
`projectId`	UUID	yes	The project the customer belongs to.

{ "projectId": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d" }

Response

Returns the customer with status set to unsubscribed. See List customers for the meaning of each field.

Errors

Returns 404 if no customer with that ID exists in the project.

Example

curl -X POST "https://app.contendar.com/api/v1/customers/c1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b/unsubscribe" \
  -H "Authorization: Bearer ck_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "YOUR_PROJECT_ID" }'

Was this helpful?