Leads

Delete a lead

Remove a single lead. Contacted leads are soft-deleted with a retention window.

Requires one of the following scopes: leads:write, leads:all, all:all.

delete/v1/campaigns/{cid}/leads/{leadId}

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns/{cid}/leads/{leadId}
  • Auth: HTTP bearer

Path parameters

cidstring uuid required
Example:a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60
leadIdstring uuid required
Example:c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37

Headers

Idempotency-Keystring
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Response

successboolean required
retentionDaysnumber

For soft-deleted leads, days before permanent purge.

Example response

{
  "success": true,
  "retentionDays": 30
}

Changes

No recorded changes to this operation across all 1 revision of this API.