POST /leads

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Body

application/json

Lead data

campaign string required

UUID of the campaign to which the lead will be associated

Example: 550e8400-e29b-41d4-a716-446655440000
email string required

Email address of the lead

Example: john.doe@example.com
first_name string

First name of the lead

Example: John
last_name string

Last name of the lead

Example: Doe
company string

Company name of the lead

Example: Coldy
website string

Website of the lead

Example: https://coldy.ai
personalization string

Personalization text for the lead

Example: Hi John, I saw you work at Coldy.ai and thought this might be useful...
custom_variables object

Custom variables as key-value pairs where key is field name and value is its value

Example: {"position":"CTO","linkedin":"https://linkedin.com/in/coldy.ai"}
skip_if_in_campaign object

Whether to skip if the lead is already in the campaign (default: true)

Example: true
skip_if_in_workspace object

Whether to skip if the lead is already in the workspace (default: true)

Example: true
skip_if_in_blacklist object

Whether to skip if the lead is in blacklist (default: true)

Example: true

Response

application/json

Lead created successfully

id number required

ID of the lead

Example: 1
email string required

Email address of the lead

Example: john.doe@example.com
first_name string required

First name of the lead

Example: John
last_name string required

Last name of the lead

Example: Doe
company string required

Company of the lead

Example: OpenAI
website string required

Website of the lead

Example: https://openai.com
personalization string required

Personalization text

Example: Hi John, I saw you work at OpenAI…
sender string required

The email account from which the email was sent

Example: outbound@coldy.ai
verification_status string required

Verification status of the email

Allowed values: valid, unknown, accept_all, invalid, disposable, not_verified

Example: valid
status string required

Current status of the lead

Allowed values: Not contacted, Sent, Bounce, Replied, Opened

Example: Not contacted
campaign_id string required

ID of the associated campaign

Example: 550e8400-e29b-41d4-a716-446655440000
id_previous_sending_sequence number required

ID of previous sending sequence

Example: 0
amount_sequences_sent number required

Number of sequences already sent

Example: 2
date_last_sequence_send string required

Date of the last sequence sent

Example: 2025-10-01T12:34:56.000Z
reply_text string required

Reply text if lead responded

Example: Sure, let’s talk next week.
reply_status string required

Reply status

Example: positive
reply_status_tag_id number required

ID of the attached reply tag

Example: 12
stop_sending boolean required

Whether sending is stopped for this lead

Example: false
stop_sending_type string required

Type of stop sending rule applied

Example: manual
chosen_sender number required

Chosen sender account ID

Example: 101
provider string required

Provider used for sending

Example: gmail