Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

identity

account.identity Get the account identity information behind the authenticated API key Risk: read
Input: empty object Output

me

account.me Get the authenticated user’s profile and role Risk: read
Input: empty object Output

Action Plans

list

actionPlans.list List the account’s action plans Risk: read
Input Output

Action Plans People

create

actionPlansPeople.create Enroll a person into an action plan Risk: write
Input Output

list

actionPlansPeople.list List the people enrolled in action plans, filtered by person Risk: read
Input Output

update

actionPlansPeople.update Update an action plan enrollment, such as finishing it Risk: write
Input Output

Appointment Outcomes

create

appointmentOutcomes.create Create an appointment outcome with an optional sort order Risk: write
Input Output

delete

appointmentOutcomes.delete Delete an appointment outcome after reassigning its appointments to another outcome Risk: destructive
Input Output

get

appointmentOutcomes.get Get one appointment outcome by ID Risk: read
Input Output

list

appointmentOutcomes.list List the outcomes that appointments can be closed with Risk: read
Input Output

update

appointmentOutcomes.update Update an appointment outcome’s name or sort order Risk: write
Input Output

Appointments

create

appointments.create Create an appointment with invitees, optionally sending them invitations Risk: write
Input
Output

delete

appointments.delete Permanently delete an appointment Risk: destructive
Input Output

get

appointments.get Get one appointment by ID Risk: read
Input Output

list

appointments.list List appointments, filtered by person, user or date range, paged Risk: read
Input Output

update

appointments.update Update an appointment’s time, place, type or invitees Risk: write
Input
Output

Appointment Types

create

appointmentTypes.create Create an appointment type with an optional sort order Risk: write
Input Output

delete

appointmentTypes.delete Delete an appointment type after reassigning its appointments to another type Risk: destructive
Input Output

get

appointmentTypes.get Get one appointment type by ID Risk: read
Input Output

list

appointmentTypes.list List the appointment types, sorted and paged Risk: read
Input Output

update

appointmentTypes.update Update an appointment type’s name or sort order Risk: write
Input Output

Automations

get

automations.get Get one automation by ID Risk: read
Input Output

list

automations.list List the account’s automations Risk: read
Input Output

Automations People

create

automationsPeople.create Enroll a person into an automation Risk: write
Input Output

get

automationsPeople.get Get one automation enrollment by ID Risk: read
Input Output

list

automationsPeople.list List the people enrolled in automations, filtered by automation Risk: read
Input Output

update

automationsPeople.update Update an automation enrollment, such as finishing it Risk: write
Input Output

Calls

create

calls.create Log a call on a person with its direction, duration, outcome and note Risk: write
Input Output

get

calls.get Get one logged call by ID Risk: read
Input Output

list

calls.list List logged calls, filtered by person or phone number, paged Risk: read
Input Output

update

calls.update Update a logged call’s note, outcome or duration Risk: write
Input Output

Custom Fields

create

customFields.create Create a custom field definition for people, with choices for dropdown types Risk: write
Input Output

delete

customFields.delete Permanently delete a person custom field definition Risk: destructive
Input Output

get

customFields.get Get one person custom field definition by ID Risk: read
Input Output

list

customFields.list List the custom fields available on people Risk: read
Input Output

update

customFields.update Update a person custom field’s label, choices or visibility Risk: write
Input Output

Deal Attachments

create

dealAttachments.create Attach an externally hosted file to a deal Risk: write
Input Output

delete

dealAttachments.delete Permanently delete a file attachment from a deal Risk: destructive
Input Output

get

dealAttachments.get Get one file attachment of a deal by ID Risk: read
Input Output

update

dealAttachments.update Update the file URI, name or size of a deal attachment Risk: write
Input Output

Deal Custom Fields

create

dealCustomFields.create Create a custom field definition for deals, with choices for dropdown types Risk: write
Input Output

delete

dealCustomFields.delete Permanently delete a deal custom field definition Risk: destructive
Input Output

get

dealCustomFields.get Get one deal custom field definition by ID Risk: read
Input Output

list

dealCustomFields.list List the custom fields available on deals Risk: read
Input Output

update

dealCustomFields.update Update a deal custom field’s label, choices or visibility Risk: write
Input Output

Deals

create

deals.create Create a deal on a pipeline stage with a value and description Risk: write
Input Output

delete

deals.delete Permanently delete a deal Risk: destructive
Input Output

get

deals.get Get one deal by ID with its stage, value and associated people Risk: read
Input Output

list

deals.list List deals with their stage, price and people, sorted and paged Risk: read
Input Output

update

deals.update Update a deal’s stage, value, commission or associated people Risk: write
Input Output

Em Campaigns

create

emCampaigns.create Create an email marketing campaign with subject and HTML body Risk: write
Input Output

list

emCampaigns.list List the email marketing campaigns, filtered by origin Risk: read
Input Output

update

emCampaigns.update Update an email marketing campaign’s name, subject or body Risk: write
Input Output

Em Events

create

emEvents.create Record email marketing events against subscriber email addresses Risk: write
Input
Output

list

emEvents.list List email marketing events such as sends, opens and clicks Risk: read
Input Output

Events

create

events.create Push a lead event into Follow Up Boss’s routing, which creates or matches the person and runs their action plans Risk: write
Input
Output

get

events.get Get one lead event by ID Risk: read
Input Output

list

events.list List lead events, filtered by person, type or property, paged with the keyset cursor FUB enforces on deep pages Risk: read
Input Output

Groups

create

groups.create Create a routing group of users with a distribution strategy Risk: write
Input Output

delete

groups.delete Permanently delete a routing group Risk: destructive
Input Output

get

groups.get Get one routing group by ID Risk: read
Input Output

list

groups.list List the routing groups with their distribution strategy Risk: read
Input Output

roundRobin

groups.roundRobin Read the round-robin rotation state of the routing groups Risk: read
Input Output

update

groups.update Update a routing group’s name, members or distribution Risk: write
Input Output

Inbox Apps

addMessage

inboxApps.addMessage Deliver a message from your system into an inbox app conversation Risk: write
Input
Output

addNote

inboxApps.addNote Add an internal note to an inbox app conversation Risk: write
Input
Output

addSystemConfirmationMessage

inboxApps.addSystemConfirmationMessage Add a system confirmation message to an inbox app conversation Risk: write
Input
Output

createParticipant

inboxApps.createParticipant Add a participant to an inbox app conversation Risk: write
Input
Output

deactivate

inboxApps.deactivate Deactivate an inbox app so it stops receiving conversations Risk: destructive
Input Output

deleteParticipant

inboxApps.deleteParticipant Remove a participant from an inbox app conversation Risk: destructive
Input Output

getParticipants

inboxApps.getParticipants List the participants of an inbox app conversation Risk: read
Input Output: object[]

install

inboxApps.install Install a published inbox app for a user with a subscription URL Risk: write
Input Output

installedApp

inboxApps.installedApp Read the installation details of a published inbox app Risk: read
Input Output

updateConversation

inboxApps.updateConversation Update an inbox app conversation’s subject or state Risk: write
Input
Output

updateMessage

inboxApps.updateMessage Update a message previously delivered to an inbox app conversation Risk: write
Input Output

Notes

create

notes.create Add a note to a person Risk: write
Input Output

delete

notes.delete Permanently delete a note Risk: destructive
Input Output

get

notes.get Get one note by ID, optionally with its threaded replies and reactions Risk: read
Input Output

update

notes.update Update a note’s subject, body or person Risk: write
Input Output

People

checkDuplicate

people.checkDuplicate Check whether a person with this email address or phone number already exists, and who they are assigned to, before creating a new lead Risk: read
Input Output

claim

people.claim Claim an unclaimed lead so it becomes the user’s contact Risk: write
Input Output

create

people.create Create a person, optionally merging into an existing duplicate instead of creating a new lead Risk: write
Input
Output

delete

people.delete Permanently delete a person from the account Risk: destructive
Input Output

get

people.get Get one person by ID with their contact details, stage, source, tags and timeframes Risk: read
Input Output

ignoreUnclaimed

people.ignoreUnclaimed Ignore an unclaimed lead so it is no longer offered to the user; the lead answers 204 and is not deleted Risk: write
Input Output

list

people.list List people with filters such as name, email, phone, stage, source, tags or assignment, sorted and paged Risk: read
Input Output

unclaimed

people.unclaimed List the unclaimed leads currently offered to the user Risk: read
Input Output

update

people.update Update one person’s contact details, stage, price, assignment, tags, timeframes or custom fields Risk: write
Input
Output

People Relationships

create

peopleRelationships.create Create a partner relationship attached to a person Risk: write
Input
Output

delete

peopleRelationships.delete Permanently delete a partner relationship Risk: destructive
Input Output

get

peopleRelationships.get Get one partner relationship by ID Risk: read
Input Output

list

peopleRelationships.list List the partner relationships of people, filtered by person or name Risk: read
Input Output

update

peopleRelationships.update Update the name, type or contact details of a relationship Risk: write
Input
Output

Person Attachments

create

personAttachments.create Attach an externally hosted file to a person Risk: write
Input Output

delete

personAttachments.delete Permanently delete a file attachment from a person Risk: destructive
Input Output

get

personAttachments.get Get one file attachment of a person by ID Risk: read
Input Output

update

personAttachments.update Update the file URI, name or size of a person attachment Risk: write
Input Output

Pipelines

create

pipelines.create Create a deal pipeline with an optional stage list Risk: write
Input
Output

delete

pipelines.delete Permanently delete a deal pipeline Risk: destructive
Input Output

get

pipelines.get Get one deal pipeline by ID Risk: read
Input Output

list

pipelines.list List the deal pipelines with their stages and order Risk: read
Input Output

update

pipelines.update Update a pipeline’s name, description or stage order Risk: write
Input
Output

Ponds

create

ponds.create Create a pond with the users whose leads land in it Risk: write
Input Output

delete

ponds.delete Permanently delete a pond Risk: destructive
Input Output

get

ponds.get Get one pond by ID with its assigned users Risk: read
Input Output

list

ponds.list List the ponds, the lead pools that distribute new contacts to agents Risk: read
Input Output

update

ponds.update Update a pond’s name or assigned users Risk: write
Input Output

Rate Limit

limits

rateLimit.limits Read the rate-limit levels currently configured for this system Risk: read
Input: empty object Output

usage

rateLimit.usage Read this system’s 24-hour API usage totals and rate-limit statistics Risk: read
Input: empty object Output

Reactions

create

reactions.create Add a reaction to a note or other reference Risk: write
Input Output: object[]

delete

reactions.delete Remove a reaction, sending the documented delete body Risk: destructive
Input Output

get

reactions.get Get the reactions attached to a note Risk: read
Input Output

Smart Lists

get

smartLists.get Get one smart list by ID Risk: read
Input Output

list

smartLists.list List the account smart lists, paged Risk: read
Input Output

Stages

create

stages.create Create a deal stage with an optional sort order Risk: write
Input Output

delete

stages.delete Delete a deal stage after reassigning its action plans to another stage Risk: destructive
Input Output

get

stages.get Get one deal stage by ID Risk: read
Input Output

list

stages.list List the deal stages across pipelines with their order weight Risk: read
Input Output

update

stages.update Update a deal stage’s name or sort order Risk: write
Input Output

Tasks

create

tasks.create Create a task such as a follow-up on a person Risk: write
Input Output

delete

tasks.delete Permanently delete a task Risk: destructive
Input Output

get

tasks.get Get one task by ID with its type, due date and completion status Risk: read
Input Output

list

tasks.list List tasks, filtered by person, assignee, type or due range, paged Risk: read
Input Output

update

tasks.update Update a task’s name, type, due date or completion Risk: write
Input Output

Team Inboxes

list

teamInboxes.list List the team inboxes available in the account Risk: read
Input Output

Teams

create

teams.create Create a team with members and leaders Risk: write
Input Output

delete

teams.delete Permanently delete a team Risk: destructive
Input Output

get

teams.get Get one team by ID with its members and leaders Risk: read
Input Output

list

teams.list List the teams in the account with their members Risk: read
Input Output

update

teams.update Update a team’s name, members or leaders Risk: write
Input Output

Templates

create

templates.create Create an email template with subject and body, optionally shared Risk: write
Input Output

delete

templates.delete Permanently delete an email template Risk: destructive
Input Output

get

templates.get Get one email template by ID Risk: read
Input Output

list

templates.list List the email message templates, paged Risk: read
Input Output

merge

templates.merge Render an email template for a person, merging their fields into the body Risk: write
Input
Output

update

templates.update Replace an email template’s name, subject and body Risk: write
Input Output

Text Messages

create

textMessages.create Log a text message on a person with its direction and byline details Risk: write
Input Output

get

textMessages.get Get one text message by ID Risk: read
Input Output

list

textMessages.list List text messages, filtered by person or phone number, paged Risk: read
Input Output

Text Message Templates

create

textMessageTemplates.create Create a text message template, optionally shared Risk: write
Input Output

delete

textMessageTemplates.delete Permanently delete a text message template Risk: destructive
Input Output

get

textMessageTemplates.get Get one text message template by ID Risk: read
Input Output

list

textMessageTemplates.list List the text message templates, paged Risk: read
Input Output

merge

textMessageTemplates.merge Render a text message template for a person, merging their fields into the message Risk: write
Input
Output

update

textMessageTemplates.update Update a text message template’s name or message Risk: write
Input Output

Threaded Replies

get

threadedReplies.get Get the threaded replies of a note Risk: read
Input Output

Timeframes

list

timeframes.list List the named timeframes available for people Risk: read
Input: empty object Output

Users

delete

users.delete Permanently remove a user from the account Risk: destructive
Input Output

get

users.get Get one user by ID with their role and contact details Risk: read
Input Output

list

users.list List the users of the account with their roles Risk: read
Input Output

Webhook Events

get

webhookEvents.get List the delivery events recorded for one webhook subscription Risk: read
Input Output: object[]

Webhooks

create

webhooks.create Subscribe a URL to one Follow Up Boss event Risk: write
Input Output

delete

webhooks.delete Permanently delete a webhook subscription Risk: destructive
Input Output

get

webhooks.get Get one webhook subscription by ID Risk: read
Input Output

list

webhooks.list List the webhook subscriptions of the account Risk: read
Input Output

update

webhooks.update Update a webhook subscription’s URL or event type Risk: write
Input Output