PedibeeDocs

Delete a contact

Delete a contact and their outreach history.

DELETE/api/v1/contacts/:id
Scopecontacts:write

Deletes the contact, their outreach history and their place in every list. This can't be undone.

Deleting a contact doesn't put the address on your do-not-email list: if they asked not to be emailed, set their stage to UNSUBSCRIBED instead of deleting them.

Path parameters

Prop

Type

Example request

curl -X DELETE "https://api.pedibee.com/api/v1/contacts/66f1c2a9e4b0a1b2c3d4e5f6" \
  -H "Authorization: Bearer $PEDIBEE_API_KEY"

Response

200 OK
{
  "deleted": true,
  "id": "66f1c2a9e4b0a1b2c3d4e5f6"
}

Errors

Every error is { "error": "…" } with a message you can show. See Errors and limits.

StatusWhen
403The key doesn’t have contacts:write, or its creator’s role no longer allows it.
404No contact with this id in your workspace.
401The API key is missing, invalid, revoked or expired.
429Too many requests. Wait for the seconds in Retry-After.

On this page