API Documentation
Status
Workspaces
Leads
- POSTCreate a lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate a lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Lists
Connect a list to a campaign
POST
/
lists
/
{id}
/
campaign
Copy
curl --request POST \
--url https://api.breakcold.com/rest/lists/{id}/campaign \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id_campaign": "<string>"
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"order": 123,
"emoji": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"can_be_delete": true,
"deleted_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"favorite": true,
"schema": "<string>",
"id_space": "<string>",
"attribute_definitions_order": [
"<string>"
]
}
Authorizations
Path Parameters
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
Copy
curl --request POST \
--url https://api.breakcold.com/rest/lists/{id}/campaign \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id_campaign": "<string>"
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"order": 123,
"emoji": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"can_be_delete": true,
"deleted_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"favorite": true,
"schema": "<string>",
"id_space": "<string>",
"attribute_definitions_order": [
"<string>"
]
}
Assistant
Responses are generated using AI and may contain mistakes.