PATCH
/
lead
/
{id_lead}
curl --request PATCH \
  --url https://api.breakcold.com/lead/{id_lead} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "data": {
    "id": "<string>",
    "email": "jsmith@example.com",
    "company": "<string>",
    "is_company": true,
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "linkedin_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "company_role": "<string>",
    "icebreaker": "<string>",
    "icebreaker_2": "<string>",
    "icebreaker_3": "<string>",
    "icebreaker_4": "<string>",
    "avatar_url": "<string>",
    "status": [
      {
        "id": "<string>"
      }
    ],
    "tags": [
      {
        "id": "<string>"
      }
    ],
    "lists": [
      {
        "id": "<string>"
      }
    ]
  },
  "options": {
    "tagsConnect": false,
    "tagsDisconnect": true,
    "statusDisconnect": true,
    "statusConnect": false
  }
}'
{
  "id": "<string>",
  "email": "jsmith@example.com",
  "company": "<string>",
  "is_company": true,
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "linkedin_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "company_role": "<string>",
  "icebreaker": "<string>",
  "icebreaker_2": "<string>",
  "icebreaker_3": "<string>",
  "icebreaker_4": "<string>",
  "avatar_url": "<string>",
  "status": [
    {
      "id": "<string>"
    }
  ],
  "tags": [
    {
      "id": "<string>"
    }
  ],
  "lists": [
    {
      "id": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id_lead
string
required

The unique identifier of the lead to update.

Query Parameters

​
id_space
string

The unique identifier of the workspace. Required unless 'X-API-KEY' is provided.

Body

application/json
Lead data to be updated.
​
data
object
​
options
object

Response

200
application/json
Lead updated successfully.
​
id
string
​
email
string
​
company
string | null
​
is_company
boolean | null

Flag to indicate if the lead is a company, by default it's a person so it's false

​
first_name
string | null
​
last_name
string | null
​
phone
string | null
​
linkedin_url
string | null
​
created_at
string | null
​
updated_at
string | null
​
company_role
string | null
​
icebreaker
string | null
​
icebreaker_2
string | null
​
icebreaker_3
string | null
​
icebreaker_4
string | null
​
avatar_url
string | null
​
status
object[]
​
tags
object[]
​
lists
object[]
Get LeadsCreate Lead