Breakcold home page
v3
Search...
Login
Support
Login
Search...
Navigation
Notes
List notes
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
List notes
POST
/
notes
/
list
Send
Authorization
X-API-KEY
string
*
X-API-KEY
Required
string
Body
object
*
id_lead
string
id_lead
string
thread_id
string
thread_id
string
pagination
object
pagination
object
page_size
number
page_size
number
page
number
page
number
Authorizations
X-API-KEY
string
header
required
Body
application/json
id_lead
string
thread_id
string
pagination
object
Show child attributes
pagination.
page_size
number
default: 50
Required range:
0 < x < 100
pagination.
page
number
default: 0
Required range:
x > 0
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
Remove a list from a campaign
Create a note
