Skip to main content
POST
Bulk mutate leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Maximum string length: 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

cid
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Body

application/json
operation
enum<string>
required
Available options:
set_status,
add_tags,
remove_tags,
delete
ids
string[]

Target lead ids. Required for every operation except a filter-based delete.

Maximum array length: 1000
Example:
filter
object

Select targets by filter instead of ids - supported ONLY for delete, and must contain at least one condition (an empty filter is rejected).

all
boolean

Delete EVERY lead in the campaign. Only valid for delete, and mutually exclusive with ids / filter. Required as an explicit opt-in for mass deletion - an empty filter will NOT delete all.

Example:

false

status
enum<string>

Required for set_status. Only user-settable statuses are allowed; platform-managed ones such as email_sent or scheduled are rejected. Reply-based statuses (lead_replied_*, lead_converted) require the lead to have already replied. lead_lost and blacklisted can be set at any time.

Available options:
lead_replied_interested,
lead_replied_meeting_request,
lead_replied_out_of_office,
lead_replied_wrong_person,
lead_replied_not_interested,
lead_replied_unsubscribed,
lead_replied_uncategorized,
lead_converted,
lead_lost,
blacklisted
tags
string[]

Required for add_tags / remove_tags.

Example:

Response

operation
enum<string>
required
Available options:
set_status,
add_tags,
remove_tags,
delete
affected
number
required

Number of leads successfully affected.

Example:

42

failed
number
required

Number of leads that could not be processed.

Example:

0

errors
string[]

Per-lead error messages, if any.

Example: