Skip to main content
Every activecampaign.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Account Contacts

​
create

accountContacts.create Link a contact to an account with an optional job title Risk: write
Input Output

​
delete

accountContacts.delete Remove the link between an account and a contact Risk: destructive
Input Output

​
get

accountContacts.get Retrieve an account-contact association by its ID Risk: read
Input Output

​
list

accountContacts.list List associations between accounts and contacts Risk: read
Input Output

​
update

accountContacts.update Update an account-contact association Risk: write
Input Output

​
Account Custom Field Data

​
create

accountCustomFieldData.create Set a custom field value on an account Risk: write
Input Output

​
createBulk

accountCustomFieldData.createBulk Set many account custom field values in one request Risk: write
Input
Output: empty object

​
delete

accountCustomFieldData.delete Delete a custom field value from an account Risk: destructive
Input Output

​
get

accountCustomFieldData.get Retrieve an account custom field value by its ID Risk: read
Input Output

​
list

accountCustomFieldData.list List custom field values stored against accounts Risk: read
Input Output

​
update

accountCustomFieldData.update Update a custom field value on an account Risk: write
Input Output

​
updateBulk

accountCustomFieldData.updateBulk Update many account custom field values in one request Risk: write
Input
Output: empty object

​
Account Custom Field Meta

​
create

accountCustomFieldMeta.create Define a new custom field for accounts Risk: write
Input Output

​
delete

accountCustomFieldMeta.delete Delete an account custom field definition Risk: destructive
Input Output

​
get

accountCustomFieldMeta.get Retrieve an account custom field definition by its ID Risk: read
Input Output

​
list

accountCustomFieldMeta.list List custom field definitions for accounts Risk: read
Input Output

​
update

accountCustomFieldMeta.update Update an account custom field definition Risk: write
Input Output

​
Accounts

​
create

accounts.create Create a CRM account with a unique name Risk: write
Input
Output

​
delete

accounts.delete Delete a CRM account and its associated data Risk: destructive
Input Output

​
deleteBulk

accounts.deleteBulk Delete many CRM accounts in one request Risk: destructive
Input Output

​
get

accounts.get Retrieve a CRM account by its ID Risk: read
Input Output

​
list

accounts.list List CRM accounts, optionally filtered by name Risk: read
Input Output

​
update

accounts.update Update an existing CRM account by its ID Risk: write
Input
Output

​
upsert

accounts.upsert Create a CRM account, or update the one with the same name Risk: write
Input
Output

​
Activities

​
list

activities.list List account activity, optionally narrowed to one contact Risk: read
Input Output

​
Addresses

​
create

addresses.create Create a company address for campaign footers Risk: write
Input Output

​
delete

addresses.delete Delete a company address by its ID Risk: destructive
Input Output

​
get

addresses.get Retrieve a company address by its ID Risk: read
Input Output

​
list

addresses.list List the company addresses used in campaigns Risk: read
Input Output

​
update

addresses.update Update an existing company address Risk: write
Input Output

​
Address Groups

​
delete

addressGroups.delete Delete an address group by its ID Risk: destructive
Input Output

​
Automations

​
list

automations.list List automation workflows Risk: read
Input Output

​
Brandings

​
get

brandings.get Retrieve a branding configuration by its ID Risk: read
Input Output

​
update

brandings.update Update branding such as site name, logo and favicon Risk: write
Input Output

​
Browse Sessions

​
addToCart

browseSessions.addToCart Flag a browse session as having items added to cart Risk: write
Input Output: empty object

​
save

browseSessions.save Create a browse session in a specified state Risk: write
Input
Output: empty object
browseSessions.search Search browse sessions for a contact and connection Risk: read
Input Output

​
testEvent

browseSessions.testEvent Simulate a tracking event and return its debug output Risk: write
Input Output: empty object

​
Calendars

​
create

calendars.create Create a calendar feed for external calendar apps Risk: write
Input Output

​
delete

calendars.delete Delete a calendar feed by its ID Risk: destructive
Input Output

​
get

calendars.get Retrieve a calendar feed by its ID Risk: read
Input Output

​
list

calendars.list List calendar feeds configured on the account Risk: read
Input Output

​
update

calendars.update Update a calendar feed by its ID Risk: write
Input Output

​
Campaigns

​
create

campaigns.create Create a broadcast or automation campaign Risk: write
Input
Output

​
duplicate

campaigns.duplicate Duplicate a campaign with its content and configuration Risk: write
Input Output

​
get

campaigns.get Retrieve a campaign by its ID with engagement metrics Risk: read
Input Output

​
getAutomationLists

campaigns.getAutomationLists List the lists a campaign automation sends to Risk: read
Input Output

​
getAutomations

campaigns.getAutomations List automations linked to a campaign Risk: read
Input Output
campaigns.getLinks List the tracked links belonging to a campaign Risk: read
Input Output

​
getMessages

campaigns.getMessages List the messages attached to a campaign Risk: read
Input Output

​
getUser

campaigns.getUser Retrieve the user who owns a campaign Risk: read
Input Output

​
list

campaigns.list List campaigns with pagination and filters Risk: read
Input Output

​
update

campaigns.update Edit an existing campaign, such as its name Risk: write
Input Output

​
Configs

​
update

configs.update Update an account configuration value Risk: write
Input Output

​
Connections

​
create

connections.create Create a connection to an external e-commerce service Risk: write
Input Output

​
delete

connections.delete Delete a connection by its ID Risk: destructive
Input Output

​
get

connections.get Retrieve a connection by its ID Risk: read
Input Output

​
list

connections.list List Deep Data connections to external services Risk: read
Input Output

​
update

connections.update Update an existing connection Risk: write
Input Output

​
Contact Automations

​
add

contactAutomations.add Enrol a contact in an automation by email address Risk: write
Input Output

​
entryCounts

contactAutomations.entryCounts Count how many times a contact entered each automation Risk: read
Input Output: empty object

​
get

contactAutomations.get Retrieve a contact automation enrolment by its ID Risk: read
Input Output

​
list

contactAutomations.list List contact enrolments across automations Risk: read
Input Output

​
remove

contactAutomations.remove Remove a contact from an automation, one run or all Risk: destructive
Input Output

​
Contact Deals

​
create

contactDeals.create Add a secondary contact to a deal Risk: write
Input Output

​
delete

contactDeals.delete Remove a secondary contact from a deal Risk: destructive
Input Output

​
get

contactDeals.get Retrieve a secondary contact association by its ID Risk: read
Input Output

​
list

contactDeals.list List secondary contacts associated with deals Risk: read
Input Output

​
update

contactDeals.update Update a secondary contact association Risk: write
Input Output

​
Contact Lists

​
list

contactLists.list List all contact-to-list memberships Risk: read
Input Output

​
Contacts

​
createOrUpdate

contacts.createOrUpdate Create a contact, or update it if the email already exists Risk: write
Input
Output

​
delete

contacts.delete Delete a contact by its ID Risk: destructive
Input Output

​
find

contacts.find Find a contact by email address Risk: read
Input Output

​
get

contacts.get Retrieve a contact by its ID Risk: read
Input Output

​
getAccountContacts

contacts.getAccountContacts List the accounts a contact is associated with Risk: read
Input Output

​
getAutomations

contacts.getAutomations List the automations a contact is enrolled in Risk: read
Input Output

​
getData

contacts.getData Retrieve the geographic and tracking data of a contact Risk: read
Input Output

​
getDeals

contacts.getDeals List the deals associated with a contact Risk: read
Input Output

​
getFieldValues

contacts.getFieldValues List the custom field values of a contact Risk: read
Input Output

​
getGeoIps

contacts.getGeoIps List the geo IP records associated with a contact Risk: read
Input Output

​
getGoals

contacts.getGoals List the automation goals a contact has completed Risk: read
Input Output

​
getLists

contacts.getLists List the list memberships of a contact Risk: read
Input Output

​
getLogs

contacts.getLogs List the activity log entries for a contact Risk: read
Input Output

​
getNotes

contacts.getNotes List the notes attached to a contact Risk: read
Input Output

​
getOrganization

contacts.getOrganization Retrieve the organization a contact belongs to Risk: read
Input Output

​
getPlusAppend

contacts.getPlusAppend Retrieve third-party enrichment data for a contact Risk: read
Input Output

​
getScoreValues

contacts.getScoreValues List the score values of a contact Risk: read
Input Output

​
getTags

contacts.getTags List the tags applied to a contact Risk: read
Input Output

​
getTrackingLogs

contacts.getTrackingLogs List site and event tracking records for a contact Risk: read
Input Output

​
list

contacts.list List contacts with pagination and filters Risk: read
Input Output

​
update

contacts.update Update an existing contact by its ID Risk: write
Input
Output

​
Contact Tags

​
list

contactTags.list List all contact-to-tag associations Risk: read
Input Output

​
Contact Tasks

​
create

contactTasks.create Create a task against a contact Risk: write
Input Output

​
find

contactTasks.find Find contact tasks by title, optionally for one contact Risk: read
Input Output

​
Custom Object Records

​
delete

customObjectRecords.delete Delete a custom object record by its ID Risk: destructive
Input Output

​
deleteByExternalId

customObjectRecords.deleteByExternalId Delete a custom object record by its external ID Risk: destructive
Input Output

​
get

customObjectRecords.get Retrieve a custom object record by its ID Risk: read
Input Output

​
getByExternalId

customObjectRecords.getByExternalId Retrieve a custom object record by its external ID Risk: read
Input Output

​
list

customObjectRecords.list List the records belonging to a custom object schema Risk: read
Input Output

​
upsert

customObjectRecords.upsert Create or update a custom object record by external ID Risk: write
Input
Output

​
Custom Object Schemas

​
create

customObjectSchemas.create Create a custom object schema Risk: write
Input
Output

​
createChild

customObjectSchemas.createChild Create a child schema under a public parent schema Risk: write
Input Output

​
delete

customObjectSchemas.delete Delete a custom object schema and all its records Risk: destructive
Input Output

​
get

customObjectSchemas.get Retrieve a custom object schema by its ID Risk: read
Input Output

​
list

customObjectSchemas.list List custom object schema definitions Risk: read
Input Output

​
update

customObjectSchemas.update Update a custom object schema or add field options Risk: write
Input
Output

​
Deal Activities

​
list

dealActivities.list List recent activity across deals Risk: read
Input Output

​
Deal Custom Field Data

​
delete

dealCustomFieldData.delete Delete a custom field value from a deal Risk: destructive
Input Output

​
get

dealCustomFieldData.get Retrieve a deal custom field value by its ID Risk: read
Input Output

​
list

dealCustomFieldData.list List custom field values stored against deals Risk: read
Input Output

​
update

dealCustomFieldData.update Update a custom field value on a deal Risk: write
Input Output

​
Deal Custom Field Meta

​
create

dealCustomFieldMeta.create Create a custom field definition for deals Risk: write
Input Output

​
delete

dealCustomFieldMeta.delete Delete a deal custom field definition Risk: destructive
Input Output

​
get

dealCustomFieldMeta.get Retrieve a deal custom field definition by its ID Risk: read
Input Output

​
list

dealCustomFieldMeta.list List custom field definitions for deals Risk: read
Input Output

​
update

dealCustomFieldMeta.update Update a deal custom field definition Risk: write
Input Output

​
Deal Groups

​
create

dealGroups.create Create a deal pipeline with its three default stages Risk: write
Input Output

​
delete

dealGroups.delete Delete a pipeline and every stage and deal in it Risk: destructive
Input Output

​
get

dealGroups.get Retrieve a deal pipeline by its ID Risk: read
Input Output

​
list

dealGroups.list List deal pipelines, optionally filtered by title Risk: read
Input Output

​
update

dealGroups.update Update a deal pipeline by its ID Risk: write
Input Output

​
Deal Roles

​
create

dealRoles.create Create a deal role such as Decision Maker Risk: write
Input Output

​
delete

dealRoles.delete Delete a deal role by its ID Risk: destructive
Input Output

​
list

dealRoles.list List the roles a contact can hold on a deal Risk: read
Input Output

​
Deals

​
delete

deals.delete Delete a deal by its ID Risk: destructive
Input Output

​
get

deals.get Retrieve a deal by its ID Risk: read
Input Output

​
list

deals.list List deals with pagination and filters Risk: read
Input Output

​
listFiltered

deals.listFiltered Search deals by title or filter by stage, pipeline, owner or status Risk: read
Input Output

​
update

deals.update Update an existing deal by its ID Risk: write
Input
Output

​
updateOwnersBulk

deals.updateOwnersBulk Reassign many deals to new owners in one request Risk: write
Input
Output: empty object

​
Deal Stages

​
create

dealStages.create Create a stage in a deal pipeline Risk: write
Input Output

​
delete

dealStages.delete Delete a pipeline stage by its ID Risk: destructive
Input Output

​
deleteWithDeals

dealStages.deleteWithDeals Delete a stage, optionally relocating its deals first Risk: destructive
Input Output

​
get

dealStages.get Retrieve a pipeline stage by its ID Risk: read
Input Output

​
list

dealStages.list List deal pipeline stages Risk: read
Input Output

​
moveDeals

dealStages.moveDeals Move every deal in one stage to another stage Risk: write
Input Output: empty object

​
update

dealStages.update Update a pipeline stage by its ID Risk: write
Input Output

​
Deal Tasks

​
create

dealTasks.create Create a task against a deal, contact or account Risk: write
Input Output

​
delete

dealTasks.delete Delete a deal task by its ID Risk: destructive
Input Output

​
get

dealTasks.get Retrieve a deal task by its ID Risk: read
Input Output

​
list

dealTasks.list List deal tasks with pagination Risk: read
Input Output

​
update

dealTasks.update Update an existing deal task by its ID Risk: write
Input Output

​
Deal Task Types

​
create

dealTaskTypes.create Create a task type for categorising deal tasks Risk: write
Input Output

​
get

dealTaskTypes.get Retrieve a deal task type by its ID Risk: read
Input Output

​
list

dealTaskTypes.list List the task types available for deals Risk: read
Input Output

​
update

dealTaskTypes.update Update a deal task type by its ID Risk: write
Input Output

​
Ecom Customers

​
create

ecomCustomers.create Register an e-commerce customer against a connection Risk: write
Input Output

​
delete

ecomCustomers.delete Delete an e-commerce customer and its data Risk: destructive
Input Output

​
get

ecomCustomers.get Retrieve an e-commerce customer by its ID Risk: read
Input Output

​
list

ecomCustomers.list List e-commerce customers with revenue metrics Risk: read
Input Output

​
update

ecomCustomers.update Update an e-commerce customer record Risk: write
Input Output

​
Ecom Order Products

​
get

ecomOrderProducts.get Retrieve an order product line by its ID Risk: read
Input Output

​
list

ecomOrderProducts.list List the products attached to e-commerce orders Risk: read
Input Output

​
listForOrder

ecomOrderProducts.listForOrder List the product lines belonging to one order Risk: read
Input Output

​
Ecom Orders

​
create

ecomOrders.create Record an e-commerce order for automation triggers Risk: write
Input
Output

​
delete

ecomOrders.delete Delete an e-commerce order by its ID Risk: destructive
Input Output

​
find

ecomOrders.find Find one order by its store order ID within a connection Risk: read
Input Output

​
get

ecomOrders.get Retrieve an e-commerce order by its ID Risk: read
Input Output

​
list

ecomOrders.list List e-commerce orders with pagination Risk: read
Input Output

​
update

ecomOrders.update Update an existing e-commerce order Risk: write
Input
Output

​
upsert

ecomOrders.upsert Create an order, or update the one with the same store order ID. Concurrent upserts for the same connectionid and externalid can duplicate; serialize them or use orders.upsertBulk Risk: write
Input
Output

​
Email Activities

​
list

emailActivities.list List email activity for a subscriber or deal Risk: read
Input Output

​
Event Tracking Events

​
create

eventTrackingEvents.create Whitelist a new event name for tracking Risk: write
Input Output

​
delete

eventTrackingEvents.delete Remove an event name from the tracking whitelist Risk: destructive
Input Output

​
list

eventTrackingEvents.list List the whitelisted event tracking event names Risk: read
Input Output

​
Field Options

​
createBulk

fieldOptions.createBulk Create options in bulk for a dropdown or listbox field Risk: write
Input
Output

​
Field Rels

​
create

fieldRels.create Associate a custom field with a list Risk: write
Input Output

​
delete

fieldRels.delete Remove the association between a custom field and a list Risk: destructive
Input Output

​
list

fieldRels.list List relationships between custom fields and lists Risk: read
Input Output

​
Fields

​
create

fields.create Create a new custom contact field Risk: write
Input Output

​
delete

fields.delete Delete a custom field and every value stored against it Risk: destructive
Input Output

​
get

fields.get Retrieve a custom field definition by its ID Risk: read
Input Output

​
list

fields.list List custom field definitions with pagination Risk: read
Input Output

​
update

fields.update Update an existing custom field definition Risk: write
Input Output

​
Field Values

​
delete

fieldValues.delete Delete a custom field value by its ID Risk: destructive
Input Output

​
get

fieldValues.get Retrieve a single custom field value by its ID Risk: read
Input Output

​
list

fieldValues.list List custom field values across all contacts Risk: read
Input Output

​
setForContact

fieldValues.setForContact Set a custom field value on a contact Risk: write
Input Output

​
update

fieldValues.update Update an existing custom field value by its ID Risk: write
Input Output

​
Forms

​
createOptin

forms.createOptin Record a form opt-in on behalf of a contact Risk: write
Input Output: empty object

​
delete

forms.delete Delete a form and its associated data Risk: destructive
Input Output

​
get

forms.get Retrieve a form by its ID Risk: read
Input Output

​
list

forms.list List forms with their field configuration Risk: read
Input Output

​
Group Limits

​
list

groupLimits.list List the resource limits configured per group Risk: read
Input Output

​
Group Members

​
create

groupMembers.create Add a custom field to a display group so it becomes visible Risk: write
Input Output

​
delete

groupMembers.delete Remove a custom field from its display group Risk: destructive
Input Output

​
list

groupMembers.list List which custom fields belong to which display groups Risk: read
Input Output

​
update

groupMembers.update Change the display group or ordering of a custom field Risk: write
Input Output

​
Groups

​
create

groups.create Create a permission group Risk: write
Input Output

​
delete

groups.delete Delete a permission group by its ID Risk: destructive
Input Output

​
get

groups.get Retrieve a permission group by its ID Risk: read
Input Output

​
list

groups.list List permission groups with their settings Risk: read
Input Output

​
update

groups.update Update a permission group title or description Risk: write
Input Output

​
Imports

​
createBulk

imports.createBulk Queue up to 250 contacts per call (payload under 400 KB) for asynchronous import Risk: write
Input
Output

​
getStatus

imports.getStatus Retrieve the progress of a single import batch by its ID Risk: read
Input Output

​
list

imports.list List outstanding and recently completed import batches Risk: read
Input: empty object Output

​
listAggregate

imports.listAggregate Retrieve aggregate progress across all bulk import batches Risk: read
Input: empty object Output: empty object

​
List Groups

​
create

listGroups.create Grant a user group permissions over a mailing list Risk: write
Input Output

​
Lists

​
create

lists.create Create a new mailing list Risk: write
Input Output

​
delete

lists.delete Delete a mailing list by its ID Risk: destructive
Input Output

​
get

lists.get Retrieve a mailing list by its ID Risk: read
Input Output

​
list

lists.list List mailing lists with pagination Risk: read
Input Output

​
updateSubscription

lists.updateSubscription Subscribe or unsubscribe a contact to or from a list Risk: write
Input Output

​
Messages

​
create

messages.create Create an email message with subject, sender and content Risk: write
Input Output

​
delete

messages.delete Delete an email message by its ID Risk: destructive
Input Output

​
get

messages.get Retrieve an email message by its ID Risk: read
Input Output

​
list

messages.list List email messages with pagination Risk: read
Input Output

​
update

messages.update Update an existing email message Risk: write
Input Output

​
Notes

​
addToContact

notes.addToContact Add a note to a contact identified by email address Risk: write
Input Output

​
create

notes.create Create a note against a contact, deal or account Risk: write
Input Output

​
createForAccount

notes.createForAccount Add a note to a CRM account Risk: write
Input Output

​
createForDeal

notes.createForDeal Add a note to a deal Risk: write
Input Output

​
delete

notes.delete Delete a note by its ID Risk: destructive
Input Output

​
get

notes.get Retrieve a note by its ID Risk: read
Input Output

​
list

notes.list List notes across contacts, deals and accounts Risk: read
Input Output

​
update

notes.update Update the body of an existing note Risk: write
Input Output

​
updateForAccount

notes.updateForAccount Update a note attached to a CRM account Risk: write
Input Output

​
updateForDeal

notes.updateForDeal Update a note attached to a deal Risk: write
Input Output

​
Orders

​
upsertBulk

orders.upsertBulk Create or update many orders synchronously Risk: write
Input
Output: empty object

​
upsertBulkAsync

orders.upsertBulkAsync Create or update many orders asynchronously Risk: write
Input
Output: empty object

​
Personalizations

​
create

personalizations.create Create a personalization variable Risk: write
Input Output

​
delete

personalizations.delete Delete a personalization variable Risk: destructive
Input Output

​
deleteBulk

personalizations.deleteBulk Delete many personalization variables at once Risk: destructive
Input Output

​
get

personalizations.get Retrieve a personalization variable by its ID Risk: read
Input Output

​
list

personalizations.list List personalization variables Risk: read
Input Output

​
lock

personalizations.lock Lock a personalization variable against edits Risk: write
Input Output

​
unlock

personalizations.unlock Unlock a personalization variable for editing Risk: write
Input Output

​
update

personalizations.update Edit an existing personalization variable Risk: write
Input Output

​
Products

​
create

products.create Create a product in the e-commerce catalog Risk: write
Input Output

​
delete

products.delete Delete a product from the e-commerce catalog Risk: destructive
Input Output

​
get

products.get Retrieve a catalog product by its ID Risk: read
Input Output

​
search

products.search Search the e-commerce product catalog Risk: read
Input
Output

​
update

products.update Update a catalog product Risk: write
Input Output

​
upsertBulk

products.upsertBulk Create or update many catalog products in one request Risk: write
Input
Output: empty object

​
Recurring Payments

​
search

recurringPayments.search Search recurring payment records by filter Risk: read
Input
Output

​
upsertBulk

recurringPayments.upsertBulk Create or update many recurring payments at once Risk: write
Input
Output: empty object

​
Saved Responses

​
create

savedResponses.create Create a reusable saved response template Risk: write
Input Output

​
delete

savedResponses.delete Delete a saved response template Risk: destructive
Input Output

​
get

savedResponses.get Retrieve a saved response by its ID Risk: read
Input Output

​
list

savedResponses.list List saved response templates Risk: read
Input Output

​
update

savedResponses.update Update a saved response template Risk: write
Input Output

​
Scores

​
list

scores.list List the scoring rules configured on the account Risk: read
Input Output

​
Segments

​
create

segments.create Create a segment with filtering conditions Risk: write
Input Output

​
delete

segments.delete Delete a segment and its history Risk: destructive
Input Output

​
get

segments.get Retrieve a segment by its ID Risk: read
Input Output

​
list

segments.list List contact segments Risk: read
Input Output

​
listAudiences

segments.listAudiences List saved segment summaries, known as audiences Risk: read
Input Output

​
update

segments.update Update a segment definition Risk: write
Input Output

​
Segments V2

​
countAtTimestamp

segmentsV2.countAtTimestamp Retrieve segment counts recorded before a timestamp Risk: read
Input Output

​
countHistory

segmentsV2.countHistory List historic result counts for one segment Risk: read
Input Output

​
create

segmentsV2.create Create an advanced segment with filtering conditions Risk: write
Input
Output

​
delete

segmentsV2.delete Delete a segment and every historic version of it Risk: destructive
Input Output

​
get

segmentsV2.get Retrieve a V2 segment by its UUID Risk: read
Input Output

​
getAtTimestamp

segmentsV2.getAtTimestamp Retrieve a segment as it stood at a point in time Risk: read
Input Output

​
match

segmentsV2.match Check whether a contact matches a segment Risk: read
Input Output: empty object

​
matchAll

segmentsV2.matchAll Start a match-all evaluation for every contact in a segment Risk: write
Input Output

​
matchAllResult

segmentsV2.matchAllResult Fetch a match-all result set by its run ID Risk: read
Input Output

​
matchByExternalId

segmentsV2.matchByExternalId Check segment membership using an external contact ID Risk: read
Input Output: empty object

​
matchSomeResult

segmentsV2.matchSomeResult Fetch a partial segment match result set by run ID Risk: read
Input Output

​
recentCounts

segmentsV2.recentCounts Retrieve the most recent result count per segment Risk: read
Input Output

​
revertToTimestamp

segmentsV2.revertToTimestamp Revert a segment to how it looked at a point in time Risk: write
Input Output

​
update

segmentsV2.update Update a V2 segment definition Risk: write
Input
Output

​
Sms Broadcast Lists

​
list

smsBroadcastLists.list List the SMS broadcast lists available on the account Risk: read
Input Output

​
Sms Broadcasts

​
createSnapshot

smsBroadcasts.createSnapshot Request a metrics snapshot for specific SMS broadcasts Risk: write
Input Output: empty object

​
getFailures

smsBroadcasts.getFailures Group and count SMS delivery failures for a broadcast Risk: read
Input Output: empty object

​
getMetrics

smsBroadcasts.getMetrics Retrieve delivery metrics for specific SMS broadcasts Risk: read
Input Output: empty object

​
getRecipients

smsBroadcasts.getRecipients List the contacts an SMS broadcast was sent to Risk: read
Input Output: empty object

​
getSnapshot

smsBroadcasts.getSnapshot Retrieve aggregate metrics across all SMS broadcasts Risk: read
Input: empty object Output

​
list

smsBroadcasts.list List SMS broadcasts with optional name and status filters Risk: read
Input Output

​
Sms Credits

​
get

smsCredits.get Retrieve SMS credit usage and remaining balance Risk: read
Input: empty object Output

​
Tags

​
addToContact

tags.addToContact Apply a tag to a contact Risk: write
Input Output

​
create

tags.create Create a new tag Risk: write
Input Output

​
delete

tags.delete Delete a tag by its ID Risk: destructive
Input Output

​
get

tags.get Retrieve a tag by its ID Risk: read
Input Output

​
list

tags.list List tags with pagination and search Risk: read
Input Output

​
removeFromContact

tags.removeFromContact Remove a tag from a contact by its contactTag ID Risk: destructive
Input Output

​
update

tags.update Update an existing tag by its ID Risk: write
Input Output

​
Task Outcomes

​
create

taskOutcomes.create Create a task outcome with an associated sentiment Risk: write
Input Output

​
get

taskOutcomes.get Retrieve a task outcome by its ID Risk: read
Input Output

​
list

taskOutcomes.list List the outcomes that can be assigned to tasks Risk: read
Input Output

​
Task Reminders

​
create

taskReminders.create Create a reminder ahead of a deal task due date Risk: write
Input Output

​
Templates

templates.createShareLink Create a shareable link for a campaign template Risk: write
Input Output: empty object

​
get

templates.get Retrieve a campaign template by its ID Risk: read
Input Output

​
Tracking

​
addWhitelist

tracking.addWhitelist Add a domain to the site tracking whitelist Risk: write
Input Output: empty object

​
getCode

tracking.getCode Retrieve the site tracking JavaScript snippet Risk: read
Input: empty object Output: empty object

​
getEventStatus

tracking.getEventStatus Check whether event tracking is enabled Risk: read
Input: empty object Output

​
getSiteStatus

tracking.getSiteStatus Check whether site tracking is enabled Risk: read
Input: empty object Output

​
listWhitelist

tracking.listWhitelist List the domains allowed for site tracking Risk: read
Input Output

​
removeWhitelist

tracking.removeWhitelist Remove a domain from the site tracking whitelist Risk: destructive
Input Output

​
setEventStatus

tracking.setEventStatus Enable or disable event tracking for the account Risk: write
Input Output

​
setSiteStatus

tracking.setSiteStatus Enable or disable site tracking for the account Risk: write
Input Output

​
trackEvent

tracking.trackEvent Record a custom event against a contact Risk: write
Input Output: empty object

​
Users

​
create

users.create Create an account user who can sign in Risk: write
Input Output

​
delete

users.delete Delete an account user by their ID Risk: destructive
Input Output

​
get

users.get Retrieve an account user by their ID Risk: read
Input Output

​
getByUsername

users.getByUsername Retrieve an account user by their username Risk: read
Input Output

​
getMe

users.getMe Retrieve the user the API token belongs to Risk: read
Input: empty object Output

​
list

users.list List account users with pagination and sorting Risk: read
Input Output

​
update

users.update Update an account user, including group assignment Risk: write
Input Output

​
Webhooks

​
create

webhooks.create Create a webhook subscription for account events Risk: write
Input Output

​
delete

webhooks.delete Delete a webhook subscription by its ID Risk: destructive
Input Output

​
get

webhooks.get Retrieve a webhook subscription by its ID Risk: read
Input Output

​
list

webhooks.list List configured webhook subscriptions Risk: read
Input Output

​
update

webhooks.update Update a webhook subscription Risk: write
Input Output