Delete contact - Ocoya API Docs

Deletes a contact and their send history. To stop emailing someone, unsubscribe them instead.

DELETE

https://www.app.ocoya.com/api/_public/v1/contacts/{contactId}

Delete contact

cURL

curl --request DELETE \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/{contactId} \
  --header 'X-API-Key: <api-key>'

{
  "id": "<string>",
  "deleted": true
}

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

contactIdstringrequired

Contact ID, from GET /contacts.

Example:"cmwdke27h0045y0k4fi0tm5pj"

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

200application/json

Deleted

idstring

deletedboolean

Delete contact

cURL

curl --request DELETE \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/{contactId} \
  --header 'X-API-Key: <api-key>'

{
  "id": "<string>",
  "deleted": true
}

Was this page helpful?