Lead
Create Lead
API Documentation
Lead
- GETGet Lead
- GETGet Leads
- PATCHUpdate Lead
- POSTCreate Lead
- DELDelete Lead
- Actions
- Bulk Actions
Lists
Reminder (Task)
Lead
Create Lead
Create a new lead (Person or Company)
POST
/
lead
curl --request POST \
--url https://api.breakcold.com/rest/lead \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"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>",
"city": "<string>",
"last_name": "<string>",
"email": "<string>",
"is_company": false,
"avatar_url": "<string>",
"website_url": "<string>",
"lists": [
"<string>"
],
"status": [
"<string>"
],
"tags": [
"<string>"
],
"owners": [
"<string>"
],
"campaigns": [
"<string>"
],
"contract_currency": "USD",
"contract_value": "<string>",
"id_list": "<string>",
"attributes": {}
}'
{
"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": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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_tracked": true,
"is_deleted": true,
"is_deleted_at": "2023-11-07T05:31:56Z",
"company_enrich": "<string>",
"custom_fields": "<string>",
"custom_fields_schema": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"score": 123,
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"id_twitter_company": "<string>",
"id_twitter": "<string>",
"usersId": "<string>"
}
Authorizations
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
curl --request POST \
--url https://api.breakcold.com/rest/lead \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"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>",
"city": "<string>",
"last_name": "<string>",
"email": "<string>",
"is_company": false,
"avatar_url": "<string>",
"website_url": "<string>",
"lists": [
"<string>"
],
"status": [
"<string>"
],
"tags": [
"<string>"
],
"owners": [
"<string>"
],
"campaigns": [
"<string>"
],
"contract_currency": "USD",
"contract_value": "<string>",
"id_list": "<string>",
"attributes": {}
}'
{
"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": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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_tracked": true,
"is_deleted": true,
"is_deleted_at": "2023-11-07T05:31:56Z",
"company_enrich": "<string>",
"custom_fields": "<string>",
"custom_fields_schema": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"score": 123,
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"id_twitter_company": "<string>",
"id_twitter": "<string>",
"usersId": "<string>"
}