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
Notes
Create a note
POST
/
notes
Copy
curl --request POST \
--url https://api.breakcold.com/rest/notes \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id_lead": "<string>",
"content": "<string>",
"id_parent": "<string>",
"thread_id": "<string>"
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"is_edited": true,
"is_pinned": true,
"is_edited_at": "2023-11-07T05:31:56Z",
"is_pinned_at": "2023-11-07T05:31:56Z",
"thread_id": "<string>",
"message_id": "<string>",
"id_parent": "<string>",
"id_lead": "<string>",
"id_space": "<string>"
}
Authorizations
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/notes \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id_lead": "<string>",
"content": "<string>",
"id_parent": "<string>",
"thread_id": "<string>"
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"is_edited": true,
"is_pinned": true,
"is_edited_at": "2023-11-07T05:31:56Z",
"is_pinned_at": "2023-11-07T05:31:56Z",
"thread_id": "<string>",
"message_id": "<string>",
"id_parent": "<string>",
"id_lead": "<string>",
"id_space": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.