Remove an address from the do-not-email list
Let someone be emailed again, only because they asked.
DELETE
/api/v1/do-not-email/:emailScope
contacts:writeTakes the address off the list. A contact marked UNSUBSCRIBED goes back to CONTACTED, or NEW if they were never emailed. Sequences they were in stay stopped.
Do this only when the person themselves asked to hear from you again. Emailing someone who opted out is what gets a sender blocked by mail providers.
Path parameters
Prop
Type
Example request
curl -X DELETE "https://api.pedibee.com/api/v1/do-not-email/jane%40northwind.io" \
-H "Authorization: Bearer $PEDIBEE_API_KEY"Response
removed is false when the address wasn't on the list. stage is the contact's stage afterwards, or null when there is no contact with that address.
{
"removed": true,
"contactId": "66f1c2a9e4b0a1b2c3d4e5f6",
"stage": "CONTACTED"
}Errors
Every error is { "error": "…" } with a message you can show. See Errors and limits.
| Status | When |
|---|---|
400 | The address is empty. |
403 | The key doesn't have contacts:write, or its creator's role no longer allows it. |
401 | The API key is missing, invalid, revoked or expired. |
429 | Too many requests. Wait for the seconds in Retry-After. |