PATCH
/
leads
/
{id}
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>",
    "id_twitter": "<string>",
    "contract_currency": "USD",
    "custom_fields": "<any>",
    "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,
    "avatar_url": "<string>",
    "website_url": "<string>",
    "status_disconnect": [
      "<string>"
    ],
    "status_connect": [
      "<string>"
    ],
    "tags_disconnect": [
      "<string>"
    ],
    "tags_connect": [
      "<string>"
    ],
    "owners_disconnect": [
      "<string>"
    ],
    "owners_connect": [
      "<string>"
    ],
    "lists_connect": [
      "<string>"
    ],
    "campaigns_connect": [
      "<string>"
    ],
    "lists": [
      "<string>"
    ],
    "status": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "owners": [
      "<string>"
    ],
    "campaigns": [
      "<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>"
}

​
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

200
application/json
Successful response
​
id
string
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_tracked
boolean | null
required
​
is_deleted
boolean
required
​
is_deleted_at
string | null
required
​
company_enrich
required
​
custom_fields
required
​
custom_fields_schema
required
​
order
integer
required
​
contract_value
integer | null
required
​
contract_currency
string | null
required
​
score
integer | null
required
​
id_linkedin_company
string | null
required
​
id_linkedin
string | null
required
​
id_space
string | null
required
​
id_twitter_company
string | null
required
​
id_twitter
string | null
required
​
usersId
string | null
required
Delete a leadDelete many leads