DELETE
/
contacts
cURL
curl --request DELETE \
  --url https://api.notocat.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "contacts_removed": 123
}
This endpoint can be used to delete contacts from a workspace in bulk. This action is irreversible. By default, the endpoint will only delete contacts that are not subscribed. If you want to delete all contacts, you can pass the subscribed query parameter with the value true.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
newsletter_id
integer
required

ID of newsletter to delete contacts from

​
subscribed
boolean

By default, only contacts that are not subscribed are deleted. If you want to delete all contacts, you can pass the subscribed query parameter with the value true.

Response

200
application/json

Contacts deleted

The response is of type object.