Create lead

Create a new lead in the Robocallz system

POST /user/lead

Create lead

cURL

curl --request POST \
  --url https://app.robocallz.ai/user/lead \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "campaign_id": 123,
  "variables": {
    "customer_name": "<string>",
    "email": "<string>"
  },
  "allow_dupplicate": true
}
'

200

{
  "message": "Lead created successfully",
  "data": {
    "id": 123,
    "campaign_id": 123,
    "phone_number": "<string>",
    "variables": {
      "customer_name": "<string>",
      "email": "<string>"
    },
    "status": "created",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

phone_number · string · required

The phone number of the lead in E.164 format (e.g. [phone])

campaign_id · integer · required

The ID of the campaign to create the lead for

variables · object

The variables to pass to the lead

Show child attributes

allow_dupplicate · boolean

Whether to allow duplicate leads in a campaign.

Response

200 - application/json

Lead created successfully

message · string · default: Lead created successfully

The message of the response

data · object

The lead data object

Show child attributes