Lead
Update Lead
API Documentation
Lead
- GETGet Lead
- GETGet Leads
- PATCHUpdate Lead
- POSTCreate Lead
- DELDelete Lead
- Actions
- Bulk Actions
Lists
Reminder (Task)
Lead
Update Lead
Update a specific lead by its ID
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
Path Parameters
The unique identifier of the lead to update.
Query Parameters
The unique identifier of the workspace. Required unless 'X-API-KEY' is provided.
Body
application/json
Lead data to be updated.
The body is of type object
.
Response
200
application/json
Lead updated successfully.
The response is of type object
.
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>"
}
]
}