solarOSsolarOS Docs

Delete one Lead

Deletes one tenant-scoped Lead and its public API sidecars such as custom Field Values and External References. Missing or cross-tenant records return 404. Required scope: leads:delete.

DELETE
/leads/{id}

Deletes one tenant-scoped Lead and its public API sidecars such as custom Field Values and External References. Missing or cross-tenant records return 404. Required scope: leads:delete.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Path Parameters

id*string

Lead identifier returned by the Organization API.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/leads/string"
{  "data": {    "action": {      "confirmed": true,      "confirmationSignal": "string"    },    "resource": {}  },  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}