Skip to main content
POST
/
lead
Create a lead
curl --request POST \
  --url https://api.breakcold.com/rest/lead \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "id": "<string>",
  "company": "<string>",
  "company_role": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "linkedin_url": "<string>",
  "linkedin_company_url": "<string>",
  "facebook_username": "<string>",
  "telegram_username": "<string>",
  "whatsapp_username": "<string>",
  "youtube_username": "<string>",
  "instagram_username": "<string>",
  "twitter_name": "<string>",
  "twitter_company_name": "<string>",
  "city": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "is_company": false,
  "is_contract": false,
  "create_company_if_not_exists": true,
  "avatar_url": "<string>",
  "website_url": "<string>",
  "lists": [
    "<string>"
  ],
  "status": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "owners": [
    "<string>"
  ],
  "contract_currency": "USD",
  "contract_name": "<string>",
  "contract_value": "<string>",
  "id_list": "<string>",
  "attributes": {},
  "icebreaker": "<string>",
  "icebreaker_2": "<string>",
  "icebreaker_3": "<string>",
  "icebreaker_4": "<string>",
  "is_draft": false,
  "auto_assign_owner": true,
  "company_avatar_url": "<string>",
  "company_linkedin_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "company": "<string>",
  "phone": "<string>",
  "linkedin_url": "<string>",
  "linkedin_company_url": "<string>",
  "facebook_username": "<string>",
  "youtube_username": "<string>",
  "instagram_username": "<string>",
  "telegram_username": "<string>",
  "whatsapp_username": "<string>",
  "search_query": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "first_name": "<string>",
  "icebreaker": "<string>",
  "last_name": "<string>",
  "website_url": "<string>",
  "timezone": "<string>",
  "city": "<string>",
  "company_role": "<string>",
  "twitter_name": "<string>",
  "avatar_url": "<string>",
  "icebreaker_2": "<string>",
  "icebreaker_3": "<string>",
  "icebreaker_4": "<string>",
  "email_bounce_score": 123,
  "twitter_company_name": "<string>",
  "is_company": true,
  "is_contract": true,
  "is_tracked": true,
  "is_deleted": true,
  "is_deleted_at": "<string>",
  "order": 123,
  "contract_value": 123,
  "contract_currency": "<string>",
  "contract_name": "<string>",
  "score": 123,
  "ai_enabled": true,
  "ai_enabled_at": "<string>",
  "ai_summary": "<string>",
  "ai_profile": "<string>",
  "is_draft": true,
  "last_interaction_at": "<string>",
  "id_linkedin_company": "<string>",
  "id_linkedin": "<string>",
  "id_space": "<string>",
  "usersId": "<string>"
}

​
Updating Lead Custom Attributes

To update attributes for a lead, include an attributes object in the request body. Each key in the attributes object represents an attribute ID, and its corresponding value is the new value for that attribute. provider a wrong value for an attribute will result in an error response. Example: 
{
    "attributes": {
      "attribute-id-1": "New Value 1",
      "attribute-id-2": 42,
      "attribute-id-3": true,
      "select-attribute-id": "option-id-1",
      "multiselect-attribute-id": ["option-id-2", "option-id-3"]
    }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
id
string
​
company
string | null
​
company_role
string | null
​
phone
​
first_name
string | null
​
linkedin_url
string | null
​
linkedin_company_url
string | null
​
facebook_username
string
​
telegram_username
string
​
whatsapp_username
string
​
youtube_username
string
​
instagram_username
string
​
twitter_name
string | null
​
twitter_company_name
string | null
​
city
string | null
​
last_name
string | null
​
email
string | null
​
is_company
boolean
default:false
​
is_contract
boolean
default:false
​
create_company_if_not_exists
boolean
default:true
​
avatar_url
string | null
​
website_url
string | null
​
lists
​
status
​
tags
​
owners
​
contract_currency
enum<string>
Available options:
USD,
EUR,
JPY,
GBP,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
INR,
PLN
​
contract_name
string | null
​
contract_value
​
id_list
string
​
attributes
object
​
icebreaker
string | null
​
icebreaker_2
string | null
​
icebreaker_3
string | null
​
icebreaker_4
string | null
​
is_draft
boolean
default:false
​
auto_assign_owner
boolean
default:true

Auto assign the owner to the current user

​
company_avatar_url
string | null
​
company_linkedin_url
string | null

Response

Successful response

​
id
string<uuid>
required
​
email
string | null
required
​
company
string | null
required
​
phone
string | null
required
​
linkedin_url
string | null
required
​
linkedin_company_url
string | null
required
​
facebook_username
string | null
required
​
youtube_username
string | null
required
​
instagram_username
string | null
required
​
telegram_username
string | null
required
​
whatsapp_username
string | null
required
​
search_query
string | null
required
​
created_at
string
required
​
updated_at
string | null
required
​
first_name
string | null
required
​
icebreaker
string | null
required
​
last_name
string | null
required
​
website_url
string | null
required
​
timezone
string | null
required
​
city
string | null
required
​
company_role
string | null
required
​
twitter_name
string | null
required
​
avatar_url
string | null
required
​
icebreaker_2
string | null
required
​
icebreaker_3
string | null
required
​
icebreaker_4
string | null
required
​
email_bounce_score
integer | null
required
​
twitter_company_name
string | null
required
​
is_company
boolean
required
​
is_contract
boolean
required
​
is_tracked
boolean | null
required
​
is_deleted
boolean
required
​
is_deleted_at
string | null
required
​
order
integer
required
​
contract_value
integer | null
required
​
contract_currency
string | null
required
​
contract_name
string | null
required
​
score
integer | null
required
​
ai_enabled
boolean
required
​
ai_enabled_at
string | null
required
​
ai_summary
string | null
required
​
ai_profile
string | null
required
​
is_draft
boolean
required
​
last_interaction_at
string | null
required
​
id_linkedin_company
string | null
required
​
id_linkedin
string | null
required
​
id_space
string | null
required
​
usersId
string | null
required