Skip to Content
Alienmail Docs
Leads

Remove a lead

DELETE
/campaigns/{id}/leads/{email}

Removes one lead from a campaign and cancels their waiting emails. The emails the campaign already sent them stay in its statistics, and the person stays in your workspace's leads. An archived campaign returns 409.

Requires the LEAD_CAMPAIGN_ENROLL permission.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key of your workspace, from Workspace settings, Integrations. Each key has a role, and the role decides which endpoints it may call.

Path Parameters

id*integer

The campaign id: the number in the campaign URL in Alienmail, or id from the campaign list. An id that is not a campaign of your workspace returns 404.

email*string

The lead email address. Encode it for a URL (@ as %40). Upper and lower case are treated the same.

Response Body

The lead was removed.

application/json
  1. response
removed*boolean
Example Request
curl -X DELETE 'https://app.alienmail.io/api/v1/campaigns/42/leads/ada@example.com'
Example Response
{  "removed": true}