Skip to main content
POST
Bulk assign leads to organization users

Authorizations

Authorization
string
header
required

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

Body

application/json
organization_user_ids
string<uuid>[]
required
Minimum array length: 1

The search query to filter leads by.

Example:

"test"

filter
enum<string>

The filter to apply to the leads.

Available options:
FILTER_VAL_CONTACTED,
FILTER_VAL_NOT_CONTACTED,
FILTER_VAL_COMPLETED,
FILTER_VAL_UNSUBSCRIBED,
FILTER_VAL_ACTIVE,
FILTER_LEAD_INTERESTED,
FILTER_LEAD_NOT_INTERESTED,
FILTER_LEAD_MEETING_BOOKED,
FILTER_LEAD_MEETING_COMPLETED,
FILTER_LEAD_CLOSED,
FILTER_LEAD_OUT_OF_OFFICE,
FILTER_LEAD_WRONG_PERSON,
FILTER_LEAD_LOST,
FILTER_LEAD_NO_SHOW,
FILTER_LEAD_CUSTOM_LABEL_POSITIVE,
FILTER_LEAD_CUSTOM_LABEL_NEGATIVE,
FILTER_VAL_BOUNCED,
FILTER_VAL_SKIPPED,
FILTER_VAL_RISKY,
FILTER_VAL_INVALID,
FILTER_VAL_VALID,
FILTER_VAL_IN_SUBSEQUENCE,
FILTER_VAL_OPENED_NO_REPLY,
FILTER_VAL_COMPLETED_NO_REPLY,
FILTER_VAL_NO_OPENS,
FILTER_VAL_REPLIED,
FILTER_VAL_LINK_CLICKED
Example:

"FILTER_LEAD_CLOSED"

campaign
string<uuid>

The ID of the campaign to filter leads by.

Example:

"019f985c-9362-73ae-903a-6fbd1a5e35f1"

list_id
string<uuid>

The ID of the list to filter leads by.

Example:

"019f985c-9362-73ae-903a-6fbe38d1ab05"

in_campaign
boolean

Whether the leads are in the campaign.

Example:

true

in_list
boolean

Whether the leads are in the list.

Example:

true

smart_view_id
string<uuid>

The ID of the smart view to filter leads by.

Example:

"019f985c-9362-73ae-903a-6fc0b03f8f8e"

ids
string<uuid>[]

The IDs of the leads to filter by.

limit
integer

The limit of the number of leads to return.

Required range: x >= 0
Example:

10

queries
object[]
assigned_to
string<uuid>

Filter leads by their current owner (the user they are currently assigned to).

Example:

"019f985c-9362-73ae-903a-6fc2164c1fec"

has_clause
boolean

Whether this endpoint should list data based on the filters currently applied in the web app.

Example:

true

Response

Default Response

status
string
Example:

"accepted"

message
string
Example:

"Your request will be processed in a background job"