Create Lead

Create one or more leads in a single request.

When to use. Import leads into your account in bulk. To change existing leads, use PUT /leads/{id} for one lead or PUT /leads/mass-update for many.

Request body. A JSON array of lead objects. Only phone is required on each lead. Other fields are optional, including first_name, last_name, phone2, address fields, purchase details, email, birthdate, loan_amount, and a customFields object of your own field name and value pairs.

Returns. { "leads": [ ... ] } containing the created leads, each with its assigned id and any customFields.

Example. POST /api/leads with body [ { "phone": "12125551234", "first_name": "John" } ]

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

Dialer Name (subdomain)

Body Params
Body
Responses

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