Delete a lead

Removes the staging row. The customer record it became, if any, is left alone — deleting the lead does not take the relationship with it.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

leads:write

Path Parameters

Name	Type	Required	Description
`leadId`	string	Required	Lead ID.

DELETEExample request

curl

curl -X DELETE "https://www.pxb.app/api/public/v1/leads/{leadId}" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Lead deleted successfully!",
  "content": {
    "leadId": "led_5c21"
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Leads

/xrm/leads

Open the ⋯ menu on a lead → Delete.