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>"
}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>"
}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"]
}
}
USD, EUR, JPY, GBP, AUD, CAD, CHF, CNY, HKD, NZD, INR, PLN Auto assign the owner to the current user
Successful response
Was this page helpful?