Delete campaign leads
Authorization
bearerAuth Paste the full personal access token or organization API key value. Examples: acq_live_..., acq_org_.... Tokens can be limited to resource/action scopes such as workspaces:read, people:write, and deals:write. Some integration endpoints require an organization key even when a personal token has the named resource scope.
In: header
Path Parameters
Workspace id.
uuidCampaign id.
uuidHeader Parameters
Required. Client-provided key that makes retries safe. Reusing the same key with the same request replays the original operation and never deletes twice. Recommended: a v4 UUID.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Send either { "all": true } to delete every lead in the campaign, or { "leadIds": [...] } to delete specific leads.
Send either { "all": true } to delete every lead in the campaign, or { "leadIds": [...] } to delete specific leads.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/leads" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "all": true }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "succeeded", "links": { "self": "http://example.com" }}{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "queued", "links": { "self": "http://example.com" }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}{ "error": { "code": "string", "message": "string", "requestId": "string", "details": null }}