Skip to main content
POST
Create lead
This endpoint allows you to create a new lead in the HeyFred system.

Request body

string
required
The phone number of the lead in E.164 format (e.g. +1234567890)
integer
required
The ID of the campaign to create the lead for
object
Custom variables to pass to the lead. You can include any variables that are defined on your assistant (see Call variables). The examples below are just for illustration — use your own variable names as configured in the assistant settings.
boolean
Whether to allow duplicate leads in a campaign.
array
Array of secondary contact leads to create along with the main lead

Response

string
default:"Lead created successfully"
The message of the response
object
The lead data object