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

Accounts

addAccountContacts

accounts.addAccountContacts Link contacts to an account Risk: write
Input Output: object \| object[]

addAccountUsers

accounts.addAccountUsers Add users to an account Risk: write
Input Output: object \| object[]

createAccount

accounts.createAccount Create a new account Risk: write
Input
Output: empty object

deleteAccount

accounts.deleteAccount Delete a account Risk: destructive
Input Output: object \| string \| undefined

listAccountFeed

accounts.listAccountFeed List the activity feed of an account Risk: read
Input Output: object[]

listAccountMessages

accounts.listAccountMessages List messages on an account Risk: read
Input Output: object[]

listAccounts

accounts.listAccounts List Accounts Risk: read
Input Output: object[]

retrieveAccount

accounts.retrieveAccount Retrieve a single account by ID Risk: read
Input Output: empty object

updateAccount

accounts.updateAccount Update a account Risk: write
Input
Output: empty object

updateAccountContacts

accounts.updateAccountContacts Update the contact links of an account Risk: write
Input Output: object \| object[]

updateAccountUsers

accounts.updateAccountUsers Update the users assigned to an account Risk: write
Input Output: object \| object[]

Calls

createCall

calls.createCall Create a new call Risk: write
Input Output: object \| object[]

updateCall

calls.updateCall Update a logged call Risk: write
Input Output: empty object

Campaigns

listCampaignMergeFields

campaigns.listCampaignMergeFields List the merge fields available for campaigns Risk: read
Input: empty object Output: object[]

Contacts

createContact

contacts.createContact Create a new contact Risk: write
Input
Output: object \| object[]

deleteContact

contacts.deleteContact Delete a contact Risk: destructive
Input Output: object \| string \| undefined

listContacts

contacts.listContacts List Contacts Risk: read
Input Output: object[]

retrieveContact

contacts.retrieveContact Retrieve a single contact by ID Risk: read
Input Output: empty object

updateContact

contacts.updateContact Update a contact Risk: write
Input
Output: empty object

Currencies

listCurrencies

currencies.listCurrencies List Currencies Risk: read
Input: empty object Output: object[]

Customfields

createCustomFieldSub

customfields.createCustomFieldSub Create a new customField sub-resource Risk: write
Input
Output: empty object

deleteCustomField

customfields.deleteCustomField Delete a customField Risk: destructive
Input Output: object \| string \| undefined

listCustomFieldOptions

customfields.listCustomFieldOptions List the options of a custom field Risk: read
Input Output: object[]

listCustomFields

customfields.listCustomFields List the custom fields of an item class Risk: read
Input Output: object[]

listCustomFieldTypes

customfields.listCustomFieldTypes List the custom field types supported by Salesflare Risk: read
Input: empty object Output: object[]

retrieveCustomField

customfields.retrieveCustomField Retrieve a single customField by ID Risk: read
Input Output: empty object

updateCustomField

customfields.updateCustomField Update a customField Risk: write
Input
Output: object \| number

Datasources

listEmailDataSources

datasources.listEmailDataSources List the connected email data sources Risk: read
Input Output: object[]

updateEmailDataSource

datasources.updateEmailDataSource Update a connected email data source Risk: write
Input Output: empty object

Filterfields

listFilterFields

filterfields.listFilterFields List the filter fields available for an entity Risk: read
Input Output: object[]

Groups

listGroups

groups.listGroups List Groups Risk: read
Input: empty object Output: object[]

retrieveGroup

groups.retrieveGroup Retrieve a single group by ID Risk: read
Input Output: empty object

Me

listMyContacts

me.listMyContacts List contacts assigned to the current user Risk: read
Input Output: object[]

retrieveCurrentUser

me.retrieveCurrentUser Retrieve the currently authenticated user Risk: read
Input: empty object Output: empty object

Meetings

createMeeting

meetings.createMeeting Create a new meeting Risk: write
Input Output: object \| object[]

deleteMeeting

meetings.deleteMeeting Delete a meeting Risk: destructive
Input Output: object \| string \| undefined

retrieveMeeting

meetings.retrieveMeeting Retrieve a single meeting by ID Risk: read
Input Output: empty object

updateMeeting

meetings.updateMeeting Update a meeting Risk: write
Input Output: empty object

Messages

createMessage

messages.createMessage Create a new message Risk: write
Input Output: empty object

createMessageFeedback

messages.createMessageFeedback Submit feedback for a message Risk: write
Input Output: empty object

deleteMessage

messages.deleteMessage Delete a message Risk: destructive
Input Output: object \| string \| undefined

updateMessage

messages.updateMessage Update a message Risk: write
Input Output: empty object

Opportunities

createOpportunity

opportunities.createOpportunity Create a new opportunity Risk: write
Input Output: empty object

deleteOpportunity

opportunities.deleteOpportunity Delete a opportunity Risk: destructive
Input Output: object \| string \| undefined

listOpportunities

opportunities.listOpportunities List Opportunities Risk: read
Input Output: object[]

retrieveOpportunity

opportunities.retrieveOpportunity Retrieve a single opportunity by ID Risk: read
Input Output: empty object

updateOpportunity

opportunities.updateOpportunity Update a opportunity Risk: write
Input Output: empty object

Persons

listPersons

persons.listPersons List persons resolved from email addresses Risk: read
Input Output: object[]

Pipelines

listPipelines

pipelines.listPipelines List Pipelines Risk: read
Input Output: object[]

Settings

retrieveAiSettings

settings.retrieveAiSettings Retrieve the workspace’s AI settings Risk: read
Input: empty object Output: empty object

updateAiSettings

settings.updateAiSettings Update the workspace’s AI settings Risk: write
Input
Output: empty object

Stages

listStages

stages.listStages List Stages Risk: read
Input Output: object[]

retrieveStage

stages.retrieveStage Retrieve a single stage by ID Risk: read
Input Output: empty object

Tags

createTag

tags.createTag Create a new tag Risk: write
Input Output: empty object

deleteTag

tags.deleteTag Delete a tag Risk: destructive
Input Output: object \| string \| undefined

listTags

tags.listTags List Tags Risk: read
Input Output: object[]

listTagUsage

tags.listTagUsage List the usage statistics of a tag Risk: read
Input Output: empty object

retrieveTag

tags.retrieveTag Retrieve a single tag by ID Risk: read
Input Output: empty object

updateTag

tags.updateTag Update a tag Risk: write
Input Output: empty object

Tasks

createTask

tasks.createTask Create a new task Risk: write
Input Output: empty object

deleteTask

tasks.deleteTask Delete a task Risk: destructive
Input Output: object \| string \| undefined

listTasks

tasks.listTasks List Tasks Risk: read
Input Output: object[]

updateTask

tasks.updateTask Update a task Risk: write
Input Output: empty object

Users

listUsers

users.listUsers List Users Risk: read
Input Output: object[]

retrieveUser

users.retrieveUser Retrieve a single user by ID Risk: read
Input Output: empty object

Workflows

createWorkflow

workflows.createWorkflow Create a new workflow Risk: write
Input
Output: empty object

listWorkflows

workflows.listWorkflows List Workflows Risk: read
Input Output: object[]

retrieveWorkflow

workflows.retrieveWorkflow Retrieve a single workflow by ID Risk: read
Input Output: empty object

updateWorkflow

workflows.updateWorkflow Update a workflow Risk: write
Input
Output: empty object

updateWorkflowAudience

workflows.updateWorkflowAudience Update the audience record of a workflow Risk: destructive
Input Output: empty object