Knowledge Base

API Reference

Getting Started

Breakcold

API Reference (deprecated)

Login

Support

Easily integrate with your favorite tools and services.

Integrations

Start requesting Breakcold API in a few steps.

Quickstart

Learn how to effectively use custom attributes in Breakcold to enhance your workflows.

 How to use Custom Attributes

Welcome to the Breakcold API! You can use our API to access Breakcold API endpoints, which can get information on your leads, campaigns, and more.

Introduction

Fetches details of a specific lead identified by its ID.

Get Lead

Get Leads

Update Lead

Create Lead

Delete Lead

List leads with pagination and filters

Track a lead

Untrack a lead

Delete multiple leads based on a given set of criteria.

Export leads based on filter.

Toggle tracking for leads.

Endpoint to create a new list for organizing records.

Create list

Endpoint to delete an existing list and optionally its associated leads.

Delete list

Endpoint to update the details of an existing list.

Update list

Get lists

Connect a list to a campaign.

Disconnect a list from a campaign.

List tags

Create a tag

Delete a specific tag

Update existing tag

List status

Create a status

Delete Status

Update Status

Update Many Status

Retrieve a reminder by ID

Update a specific reminder

Delete a specific reminder

Create a reminder

Get user details

Update many status

Delete a status

Update a status

Get user workspaces

Get members of a workspace

Get a lead by id

Delete a lead

Delete many leads

Update many leads

Add a list to leads

Get count of tracked leads

Track leads

id_lead need to be the company ID, id_lead_2 is the lead ID

Connect a lead to a company

Disconnect a lead from a company

Search leads

Delete a tag

Update a tag

Add your leads to a list based on filters

Add many leads to a list

Move your leads to a list based on filters

Move many leads to a list

Remove your leads from a list based on filters

Remove many leads from a list

Get all lists

Create a list

Delete a list

Update a list

Move the order of a list

Connect a list to a campaign

Remove a list from a campaign

List notes

Create a note

Get a note

Delete a note

Update a note

List campaigns

List reminders with filters and pagination

Get a reminder

Delete a reminder

Update a reminder

List attributes

Create an attributes

Delete an attribute

Update an attribute

List attributes for Zapier

List attributes for Make

Retrieve all notes for a space

Get a note by ID

Update a note's content

Quick Start

Webhook

Integrations

Zapier

Make

Pabbly