Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Lead

Bulk assign leads to organization users

Bulk assign leads to organization users

post/api/v2/leads/bulk-assign

Request body

searchstring

The search query to filter leads by.

filter'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'

The filter to apply to the leads.

campaignstring uuid

The ID of the campaign to filter leads by.

list_idstring uuid

The ID of the list to filter leads by.

in_campaignboolean

Whether the leads are in the campaign.

in_listboolean

Whether the leads are in the list.

organization_user_idsstring[] required
smart_view_idstring uuid

The ID of the smart view to filter leads by.

idsstring[]

The IDs of the leads to filter by.

limitinteger

The limit of the number of leads to return.

assigned_tostring uuid

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

has_clauseboolean

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

Example request

{
  "search": "test",
  "filter": "FILTER_LEAD_CLOSED",
  "campaign": "019f94cd-aeee-7a1b-8e81-7d163a0f18a1",
  "list_id": "019f94cd-aeee-7a1b-8e81-7d174ed25b07",
  "in_campaign": true,
  "in_list": true,
  "organization_user_ids": [
    "019f94cd-aeee-7a1b-8e81-7d1807d82898"
  ],
  "smart_view_id": "019f94cd-aeee-7a1b-8e81-7d195badd3ac",
  "ids": [
    "019f94cd-aeee-7a1b-8e81-7d1a08e8d1d9"
  ],
  "limit": 10,
  "queries": [
    {
      "actionType": "email-open",
      "values": {
        "occurrence-days": 5,
        "occurrence-count": {
          "condition": "more",
          "count": 5
        },
        "lead-status": {
          "status": 5,
          "condition": "is"
        }
      }
    }
  ],
  "assigned_to": "019f94cd-aeee-7a1b-8e81-7d1b70fa2083",
  "has_clause": true
}

Response

Default Response

statusstring
messagestring

Example response

{
  "status": "accepted",
  "message": "Your request will be processed in a background job"
}