Delete Contacts

Send either one email or an emails array.

Single delete ({ email }) returns 404 CONTACT_NOT_FOUND when the contact does not exist. Batch delete ({ emails }) always responds 200; the response includes deleted (the number of contacts removed) and an optional notFound array listing any submitted emails that did not match an existing contact (omitted when every email matched).

DELETE /v1/contacts

cURL

single

curl --request DELETE \ --url https://brew.new/api/v1/contacts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "email": "[e-mail]" } '

200

allDeleted

{ "deleted": 2 }

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · default: Bearer brew_your_api_key · required

Send your Brew API key as Authorization: Bearer brew_xxx.

Body

application/json

Single delete or batch delete payload.

Option 1

Option 2

email · string<email> · required

Response

200

application/json

The contact or contacts were deleted. notFound is only included on batch deletes when one or more submitted emails did not match an existing contact.

deleted · integer · required

Required range: x >= 0

notFound · string[]

Minimum string length: 1