Dispatch Leads

Dispatch a batch of leads into your campaigns through one of your adapters. Each lead is routed to a campaign and enters the dialing queue, with its lifecycle and calling priority applied automatically.

When to use. Push new or updated leads from your own source, such as a CRM, into the dialer. Register any statuses you plan to set on those leads first, using the statuses endpoint.

Parameters.

  • adapter_id (path): the id of your adapter.
  • import_group_id (path): the id of the import group tied to that adapter.

Request body. A JSON array of lead objects. Every field is optional except id, which is your own identifier for the lead. Supported fields: id, first_name, last_name, phone, campaign, source, affiliate, country, language, status (one of the statuses you registered via the statuses endpoint), agent, email, desk, business_unit, registration_date, last_updated_at, last_login_date, first_deposit_date. Unrecognized fields are ignored.

Returns. An object keyed by each lead's original id, where each value reports whether that lead was accepted. For example: { "156015": { "success": true, "message": "" }, "181091": { "success": true, "message": "" } }.

See Dialer API concepts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The id of your adapter.

integer
required

The id of the import group tied to your adapter.

Body Params

A JSON array of leads to dispatch to your campaigns.

A JSON array of leads to push into the dialer.

Dispatch leads request
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json