v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Leads

Delete Lead

Moves a lead to the trash. A reason is required and is stored for audit. The response body is empty.

delete/v1.0/leads/{leadId}

Path parameters

leadIdinteger required

ID of the lead to trash.

Query parameters

reasonstring required

Free-text reason recorded with the trash operation.

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Response

Lead trashed.

object required

Example response

{
  "deleted": true,
  "leadId": "651095960136641"
}