Skip to main content
PATCH
/
leads
/
{id}
Update a lead
curl --request PATCH \
  --url https://api.breakcold.com/rest/leads/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "data": {
    "company": "<string>",
    "company_role": "<string>",
    "facebook_username": "<string>",
    "youtube_username": "<string>",
    "instagram_username": "<string>",
    "telegram_username": "<string>",
    "whatsapp_username": "<string>",
    "city": "<string>",
    "phone": "<string>",
    "icebreaker": "<string>",
    "icebreaker_2": "<string>",
    "icebreaker_3": "<string>",
    "icebreaker_4": "<string>",
    "contract_value": "<string>",
    "id_linkedin": "<string>",
    "contract_name": "<string>",
    "first_name": "<string>",
    "linkedin_url": "<string>",
    "linkedin_company_url": "<string>",
    "twitter_name": "<string>",
    "twitter_company_name": "<string>",
    "email_bounce_score": 123,
    "last_name": "<string>",
    "id_list": "<string>",
    "email": "<string>",
    "is_company": true,
    "is_contract": true,
    "avatar_url": "<string>",
    "website_url": "<string>",
    "ai_enabled": true,
    "status_disconnect": [
      "<string>"
    ],
    "status_connect": [
      "<string>"
    ],
    "tags_disconnect": [
      "<string>"
    ],
    "tags_connect": [
      "<string>"
    ],
    "owners_disconnect": [
      "<string>"
    ],
    "owners_connect": [
      "<string>"
    ],
    "lists_connect": [
      "<string>"
    ],
    "lists": [
      "<string>"
    ],
    "status": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "owners": [
      "<string>"
    ],
    "attributes": {},
    "is_draft": true
  }
}
'
import requests

url = "https://api.breakcold.com/rest/leads/{id}"

payload = { "data": {
        "company": "<string>",
        "company_role": "<string>",
        "facebook_username": "<string>",
        "youtube_username": "<string>",
        "instagram_username": "<string>",
        "telegram_username": "<string>",
        "whatsapp_username": "<string>",
        "city": "<string>",
        "phone": "<string>",
        "icebreaker": "<string>",
        "icebreaker_2": "<string>",
        "icebreaker_3": "<string>",
        "icebreaker_4": "<string>",
        "contract_value": "<string>",
        "id_linkedin": "<string>",
        "contract_name": "<string>",
        "first_name": "<string>",
        "linkedin_url": "<string>",
        "linkedin_company_url": "<string>",
        "twitter_name": "<string>",
        "twitter_company_name": "<string>",
        "email_bounce_score": 123,
        "last_name": "<string>",
        "id_list": "<string>",
        "email": "<string>",
        "is_company": True,
        "is_contract": True,
        "avatar_url": "<string>",
        "website_url": "<string>",
        "ai_enabled": True,
        "status_disconnect": ["<string>"],
        "status_connect": ["<string>"],
        "tags_disconnect": ["<string>"],
        "tags_connect": ["<string>"],
        "owners_disconnect": ["<string>"],
        "owners_connect": ["<string>"],
        "lists_connect": ["<string>"],
        "lists": ["<string>"],
        "status": ["<string>"],
        "tags": ["<string>"],
        "owners": ["<string>"],
        "attributes": {},
        "is_draft": True
    } }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {
      company: '<string>',
      company_role: '<string>',
      facebook_username: '<string>',
      youtube_username: '<string>',
      instagram_username: '<string>',
      telegram_username: '<string>',
      whatsapp_username: '<string>',
      city: '<string>',
      phone: '<string>',
      icebreaker: '<string>',
      icebreaker_2: '<string>',
      icebreaker_3: '<string>',
      icebreaker_4: '<string>',
      contract_value: '<string>',
      id_linkedin: '<string>',
      contract_name: '<string>',
      first_name: '<string>',
      linkedin_url: '<string>',
      linkedin_company_url: '<string>',
      twitter_name: '<string>',
      twitter_company_name: '<string>',
      email_bounce_score: 123,
      last_name: '<string>',
      id_list: '<string>',
      email: '<string>',
      is_company: true,
      is_contract: true,
      avatar_url: '<string>',
      website_url: '<string>',
      ai_enabled: true,
      status_disconnect: ['<string>'],
      status_connect: ['<string>'],
      tags_disconnect: ['<string>'],
      tags_connect: ['<string>'],
      owners_disconnect: ['<string>'],
      owners_connect: ['<string>'],
      lists_connect: ['<string>'],
      lists: ['<string>'],
      status: ['<string>'],
      tags: ['<string>'],
      owners: ['<string>'],
      attributes: {},
      is_draft: true
    }
  })
};

fetch('https://api.breakcold.com/rest/leads/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.breakcold.com/rest/leads/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'company' => '<string>',
        'company_role' => '<string>',
        'facebook_username' => '<string>',
        'youtube_username' => '<string>',
        'instagram_username' => '<string>',
        'telegram_username' => '<string>',
        'whatsapp_username' => '<string>',
        'city' => '<string>',
        'phone' => '<string>',
        'icebreaker' => '<string>',
        'icebreaker_2' => '<string>',
        'icebreaker_3' => '<string>',
        'icebreaker_4' => '<string>',
        'contract_value' => '<string>',
        'id_linkedin' => '<string>',
        'contract_name' => '<string>',
        'first_name' => '<string>',
        'linkedin_url' => '<string>',
        'linkedin_company_url' => '<string>',
        'twitter_name' => '<string>',
        'twitter_company_name' => '<string>',
        'email_bounce_score' => 123,
        'last_name' => '<string>',
        'id_list' => '<string>',
        'email' => '<string>',
        'is_company' => true,
        'is_contract' => true,
        'avatar_url' => '<string>',
        'website_url' => '<string>',
        'ai_enabled' => true,
        'status_disconnect' => [
                '<string>'
        ],
        'status_connect' => [
                '<string>'
        ],
        'tags_disconnect' => [
                '<string>'
        ],
        'tags_connect' => [
                '<string>'
        ],
        'owners_disconnect' => [
                '<string>'
        ],
        'owners_connect' => [
                '<string>'
        ],
        'lists_connect' => [
                '<string>'
        ],
        'lists' => [
                '<string>'
        ],
        'status' => [
                '<string>'
        ],
        'tags' => [
                '<string>'
        ],
        'owners' => [
                '<string>'
        ],
        'attributes' => [
                
        ],
        'is_draft' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.breakcold.com/rest/leads/{id}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"company\": \"<string>\",\n    \"company_role\": \"<string>\",\n    \"facebook_username\": \"<string>\",\n    \"youtube_username\": \"<string>\",\n    \"instagram_username\": \"<string>\",\n    \"telegram_username\": \"<string>\",\n    \"whatsapp_username\": \"<string>\",\n    \"city\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"icebreaker\": \"<string>\",\n    \"icebreaker_2\": \"<string>\",\n    \"icebreaker_3\": \"<string>\",\n    \"icebreaker_4\": \"<string>\",\n    \"contract_value\": \"<string>\",\n    \"id_linkedin\": \"<string>\",\n    \"contract_name\": \"<string>\",\n    \"first_name\": \"<string>\",\n    \"linkedin_url\": \"<string>\",\n    \"linkedin_company_url\": \"<string>\",\n    \"twitter_name\": \"<string>\",\n    \"twitter_company_name\": \"<string>\",\n    \"email_bounce_score\": 123,\n    \"last_name\": \"<string>\",\n    \"id_list\": \"<string>\",\n    \"email\": \"<string>\",\n    \"is_company\": true,\n    \"is_contract\": true,\n    \"avatar_url\": \"<string>\",\n    \"website_url\": \"<string>\",\n    \"ai_enabled\": true,\n    \"status_disconnect\": [\n      \"<string>\"\n    ],\n    \"status_connect\": [\n      \"<string>\"\n    ],\n    \"tags_disconnect\": [\n      \"<string>\"\n    ],\n    \"tags_connect\": [\n      \"<string>\"\n    ],\n    \"owners_disconnect\": [\n      \"<string>\"\n    ],\n    \"owners_connect\": [\n      \"<string>\"\n    ],\n    \"lists_connect\": [\n      \"<string>\"\n    ],\n    \"lists\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"owners\": [\n      \"<string>\"\n    ],\n    \"attributes\": {},\n    \"is_draft\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.breakcold.com/rest/leads/{id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"company\": \"<string>\",\n    \"company_role\": \"<string>\",\n    \"facebook_username\": \"<string>\",\n    \"youtube_username\": \"<string>\",\n    \"instagram_username\": \"<string>\",\n    \"telegram_username\": \"<string>\",\n    \"whatsapp_username\": \"<string>\",\n    \"city\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"icebreaker\": \"<string>\",\n    \"icebreaker_2\": \"<string>\",\n    \"icebreaker_3\": \"<string>\",\n    \"icebreaker_4\": \"<string>\",\n    \"contract_value\": \"<string>\",\n    \"id_linkedin\": \"<string>\",\n    \"contract_name\": \"<string>\",\n    \"first_name\": \"<string>\",\n    \"linkedin_url\": \"<string>\",\n    \"linkedin_company_url\": \"<string>\",\n    \"twitter_name\": \"<string>\",\n    \"twitter_company_name\": \"<string>\",\n    \"email_bounce_score\": 123,\n    \"last_name\": \"<string>\",\n    \"id_list\": \"<string>\",\n    \"email\": \"<string>\",\n    \"is_company\": true,\n    \"is_contract\": true,\n    \"avatar_url\": \"<string>\",\n    \"website_url\": \"<string>\",\n    \"ai_enabled\": true,\n    \"status_disconnect\": [\n      \"<string>\"\n    ],\n    \"status_connect\": [\n      \"<string>\"\n    ],\n    \"tags_disconnect\": [\n      \"<string>\"\n    ],\n    \"tags_connect\": [\n      \"<string>\"\n    ],\n    \"owners_disconnect\": [\n      \"<string>\"\n    ],\n    \"owners_connect\": [\n      \"<string>\"\n    ],\n    \"lists_connect\": [\n      \"<string>\"\n    ],\n    \"lists\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"owners\": [\n      \"<string>\"\n    ],\n    \"attributes\": {},\n    \"is_draft\": true\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.breakcold.com/rest/leads/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"company\": \"<string>\",\n    \"company_role\": \"<string>\",\n    \"facebook_username\": \"<string>\",\n    \"youtube_username\": \"<string>\",\n    \"instagram_username\": \"<string>\",\n    \"telegram_username\": \"<string>\",\n    \"whatsapp_username\": \"<string>\",\n    \"city\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"icebreaker\": \"<string>\",\n    \"icebreaker_2\": \"<string>\",\n    \"icebreaker_3\": \"<string>\",\n    \"icebreaker_4\": \"<string>\",\n    \"contract_value\": \"<string>\",\n    \"id_linkedin\": \"<string>\",\n    \"contract_name\": \"<string>\",\n    \"first_name\": \"<string>\",\n    \"linkedin_url\": \"<string>\",\n    \"linkedin_company_url\": \"<string>\",\n    \"twitter_name\": \"<string>\",\n    \"twitter_company_name\": \"<string>\",\n    \"email_bounce_score\": 123,\n    \"last_name\": \"<string>\",\n    \"id_list\": \"<string>\",\n    \"email\": \"<string>\",\n    \"is_company\": true,\n    \"is_contract\": true,\n    \"avatar_url\": \"<string>\",\n    \"website_url\": \"<string>\",\n    \"ai_enabled\": true,\n    \"status_disconnect\": [\n      \"<string>\"\n    ],\n    \"status_connect\": [\n      \"<string>\"\n    ],\n    \"tags_disconnect\": [\n      \"<string>\"\n    ],\n    \"tags_connect\": [\n      \"<string>\"\n    ],\n    \"owners_disconnect\": [\n      \"<string>\"\n    ],\n    \"owners_connect\": [\n      \"<string>\"\n    ],\n    \"lists_connect\": [\n      \"<string>\"\n    ],\n    \"lists\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ],\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"owners\": [\n      \"<string>\"\n    ],\n    \"attributes\": {},\n    \"is_draft\": true\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

​
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: 
{
  "data": {
    "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

Path Parameters

​
id
string
required

Body

application/json
​
data
object
required

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