Breakcold home page
v3
Search...
Login
Support
Login
Search...
Navigation
Notes
Create a note
Documentation
API Reference
Knowledge Base
API Reference
API Documentation
Introduction
User
GET
Get user details
Status
GET
List status
POST
Create a status
PATCH
Update many status
DEL
Delete a status
PATCH
Update a status
Workspaces
GET
Get user workspaces
Members
GET
Get members of a workspace
Leads
POST
Create Lead
GET
Get a lead by id
DEL
Delete a lead
PATCH
Update Lead
POST
Delete many leads
PATCH
Update many leads
POST
List leads with pagination and filters
POST
Add a list to leads
POST
Track a lead
GET
Get count of tracked leads
POST
Track leads
POST
Connect a lead to a company
POST
Disconnect a lead from a company
POST
Search leads
Tags
GET
List tags
POST
Create a tag
DEL
Delete a tag
PATCH
Update a tag
Lists
POST
Add many leads to a list
POST
Move many leads to a list
POST
Remove many leads from a list
GET
Get all lists
POST
Create a list
DEL
Delete a list
PATCH
Update a list
PATCH
Move the order of a list
POST
Connect a list to a campaign
DEL
Remove a list from a campaign
Notes
POST
List notes
POST
Create a note
GET
Get a note
DEL
Delete a note
PATCH
Update a note
Campaigns
GET
List campaigns
Reminders
POST
List reminders with filters and pagination
GET
Get a reminder
DEL
Delete a reminder
PATCH
Update a reminder
POST
Create a reminder
Attributes
GET
List attributes
POST
Create an attributes
DEL
Delete an attribute
PATCH
Update an attribute
GET
List attributes for Zapier
GET
List attributes for Make
Notes
Create a note
POST
/
notes
Send
Authorization
X-API-KEY
string
*
X-API-KEY
Required
string
Body
object
*
id_lead
string
id_lead
string
content
string
*
content
Required
string
id_parent
string
id_parent
string
thread_id
string
thread_id
string
Authorizations
X-API-KEY
string
header
required
Body
application/json
content
string
required
Required string length:
1 - 5000
id_lead
string
id_parent
string
thread_id
string
Response
200 - application/json
id
string
required
content
string | null
required
created_at
string
required
updated_at
string | null
required
is_deleted
boolean
required
is_edited
boolean
required
is_pinned
boolean
required
is_edited_at
string | null
required
is_pinned_at
string | null
required
thread_id
string | null
required
message_id
string | null
required
id_parent
string | null
required
id_lead
string | null
required
id_space
string | null
required
List notes
Get a note
