Create lead

Creates a new lead in a campaign. The lead will be queued for outbound calling according to the campaign’s schedule and retry settings.

Endpoint

POST /user/lead

Request

string

required

Lead’s phone number in E.164 format (e.g., +1234567890).

integer

required

ID of the campaign to add the lead to.

object

Custom variables to pass to the call. Variable names must match those defined on the campaign’s assistant.

Show Example variables

string

Name of the customer.

string

Email address of the customer.

boolean

Whether to allow creating a duplicate lead with the same phone number in the same campaign.

array

Additional contact numbers to attempt if the primary number does not answer.

Show Secondary contact properties

string

required

Phone number in E.164 format.

object

Variables for this secondary contact.

Response

string

Confirmation message.

object

The created lead.

Show properties

integer

Unique identifier of the lead.

integer

Campaign the lead belongs to.

string

Lead’s phone number in E.164 format.

object

Variables associated with the lead.

string

Lead status — always created initially.

string

Creation timestamp.

string

Last update timestamp.

object

Abbreviated campaign info.

Show Campaign properties

integer

Campaign ID.

string

Campaign name.

array

Secondary contacts associated with this lead.

Show Secondary contact properties

integer

Secondary contact ID.

string

Phone number in E.164 format.

object

Variables for this contact.

string

Status of this contact.

string

Creation timestamp.

string

Last update timestamp.

Example

curl -X POST "https://portal.intellixent.ai/api/user/lead" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1234567890",
    "campaign_id": 1,
    "variables": {
      "customer_name": "John Doe",
      "email": "john.doe@example.com"
    }
  }'

const response = await fetch('https://portal.intellixent.ai/api/user/lead', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone_number: '+1234567890',
    campaign_id: 1,
    variables: {
      customer_name: 'John Doe',
      email: 'john.doe@example.com'
    }
  })
});

const data = await response.json();
console.log(data.data.id); // New lead ID

200 Response

{
  "message": "Lead created successfully",
  "data": {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "+1234567890",
    "variables": {
      "customer_name": "John Doe",
      "email": "john.doe@example.com"
    },
    "status": "created",
    "created_at": "2025-06-30 11:53:20",
    "updated_at": "2025-06-30 11:53:20",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": []
  }
}

Overview

Assistants

Calls

Campaigns & Leads

Conversations

Messaging

Phone Numbers

Knowledge & Tools

Webhooks

Endpoint

Request

Response

Example

​Endpoint

​Request

​Response

​Example

Endpoint

Request

Response

Example