Add addresses to the do-not-email list

Puts up to 1,000 addresses on the list. Contacts with those addresses are marked UNSUBSCRIBED, their sequences stop at once, and marketing automations they're in end. Addresses already on the list are counted in alreadyListed and left as they are.

Use it when someone asks not to be emailed through another channel, or to bring an existing suppression list over before your first campaign.

BodyCopy Anchor Link

Example requestCopy Anchor Link

curl -X POST "https://api.pedibee.com/api/v1/do-not-email" \
  -H "Authorization: Bearer $PEDIBEE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["jane@northwind.io", "sam@globex.com", "not-an-email"],
    "reason": "UNSUBSCRIBED",
    "note": "Opted out in the CRM"
  }'

ResponseCopy Anchor Link

Invalid addresses are reported, not added; the rest still go on the list.

{
  "added": 2,
  "alreadyListed": 0,
  "invalid": [
    "not-an-email"
  ]
}

ErrorsCopy Anchor Link

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