Create Lead

Creates a lead contact, an inbound message, a contact event with type api_lead, and optionally an outbound message. The outbound message can be optionally scheduled.

If the contact exists and is opted out, only an inbound message and an event will be created.

Passing a phone number that is already used by an existing contact would get the existing contact. It would not try to create a new contact with a duplicate phone number.

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

Create Lead Params

Request schema for creating a lead.

uuid
required

ID of the channel that receives and sends the messages

contact
object
required

Lead contact details

conversation
object

Lead conversation details. If a conversation exists, it is updated.

inbound_message
object
required

Lead inbound message payload

outbound_message
object

Lead outbound message payload

Responses

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