Activities
deleteRecordingTranscript
activities.deleteRecordingTranscript
Delete call recording and transcript of an activity
Risk: destructive
list
activities.list
Retrieve outreach activities across team or campaigns
Risk: read
object[]
Output full type
Output full type
Campaigns
addAbmLeads
campaigns.addAbmLeads
Add People Database contacts to an ABM campaign
Risk: destructive
data full type
data full type
archive
campaigns.archive
Archive a campaign
Risk: write
create
campaigns.create
Create a new campaign with schedule and settings
Risk: write
settings full type
settings full type
duplicate
campaigns.duplicate
Duplicate an existing campaign with sequences and schedules
Risk: write
settings full type
settings full type
exportLeads
campaigns.exportLeads
Export leads from campaign with state filtering
Risk: read
Record<string, string \| number \| boolean \| null>[] \| string
get
campaigns.get
Retrieve details of a specific campaign by ID
Risk: read
settings full type
settings full type
getBatchStats
campaigns.getBatchStats
Retrieve performance statistics for multiple campaigns
Risk: read
results full type
results full type
errors full type
errors full type
getExportStatus
campaigns.getExportStatus
Check status of an asynchronous campaign export
Risk: read
status full type
status full type
getReports
campaigns.getReports
Retrieve aggregated reports for one or multiple campaigns
Risk: read
object[]
Output full type
Output full type
getSettings
campaigns.getSettings
Retrieve all settings of a campaign
Risk: read
general full type
general full type
senders full type
senders full type
schedule full type
schedule full type
tracking full type
tracking full type
automation full type
automation full type
onReplied full type
onReplied full type
onLinkClicked full type
onLinkClicked full type
onMeetingBooked full type
onMeetingBooked full type
aiFeatures full type
aiFeatures full type
getStats
campaigns.getStats
Retrieve performance statistics for a specific campaign
Risk: read
perChannel full type
perChannel full type
steps full type
steps full type
getStatutes
campaigns.getStatutes
Retrieve validation statutes and launch blockers for a campaign
Risk: read
statutes full type
statutes full type
list
campaigns.list
Retrieve a paginated list of all campaigns in team
Risk: read
campaigns full type
campaigns full type
pagination full type
pagination full type
pause
campaigns.pause
Pause a running campaign
Risk: write
setExportEmail
campaigns.setExportEmail
Email the campaign export download link to an address when the export completes
Risk: destructive
status full type
status full type
skipStepForEveryone
campaigns.skipStepForEveryone
Skip one sequence step for every lead in campaign
Risk: destructive
skipStepForLeads
campaigns.skipStepForLeads
Skip one sequence step for specific leads in campaign
Risk: destructive
results full type
results full type
start
campaigns.start
Resume a paused campaign and allow its outreach messages to send
Risk: destructive
startExport
campaigns.startExport
Initiate asynchronous export of campaign statistics
Risk: write
unarchive
campaigns.unarchive
Restore an archived campaign
Risk: write
update
campaigns.update
Update settings and configuration of a campaign
Risk: write
aiFeatures full type
aiFeatures full type
tracking full type
tracking full type
onReplied full type
onReplied full type
onLinkClicked full type
onLinkClicked full type
onMeetingBooked full type
onMeetingBooked full type
sendUsers full type
sendUsers full type
aiFeatures full type
aiFeatures full type
tracking full type
tracking full type
onReplied full type
onReplied full type
onLinkClicked full type
onLinkClicked full type
onMeetingBooked full type
onMeetingBooked full type
updateSettings
campaigns.updateSettings
Update settings of a campaign
Risk: write
general full type
general full type
senders full type
senders full type
automation full type
automation full type
tracking full type
tracking full type
onReplied full type
onReplied full type
onLinkClicked full type
onLinkClicked full type
onMeetingBooked full type
onMeetingBooked full type
aiFeatures full type
aiFeatures full type
schedule full type
schedule full type
general full type
general full type
senders full type
senders full type
schedule full type
schedule full type
tracking full type
tracking full type
automation full type
automation full type
onReplied full type
onReplied full type
onLinkClicked full type
onLinkClicked full type
onMeetingBooked full type
onMeetingBooked full type
aiFeatures full type
aiFeatures full type
Leads
addVariables
leads.addVariables
Add custom variables to a lead
Risk: write
warnings full type
warnings full type
createInCampaign
leads.createInCampaign
Create a new lead and add it to a campaign
Risk: destructive
deleteFromCampaign
leads.deleteFromCampaign
Remove a lead from a campaign by ID (use leads.unsubscribeFromCampaign to unsubscribe)
Risk: destructive
deleteVariables
leads.deleteVariables
Erase custom variables of a lead
Risk: destructive
warnings full type
warnings full type
get
leads.get
Retrieve lead by email address or lead ID
Risk: read
object[]
Output full type
Output full type
getByEmail
leads.getByEmail
Retrieve lead details by email address
Risk: read
object[]
Output full type
Output full type
getCrmFilters
leads.getCrmFilters
Retrieve filters and list views from connected CRM
Risk: read
object[]
Output full type
Output full type
importFromCrm
leads.importFromCrm
Import leads from connected CRM filter into campaign
Risk: destructive
listInCampaign
leads.listInCampaign
Retrieve leads from a specific campaign
Risk: read
object[]
Output full type
Output full type
markInterested
leads.markInterested
Mark lead as interested across all campaigns
Risk: write
object[]
Output full type
Output full type
markInterestedInCampaign
leads.markInterestedInCampaign
Mark lead as interested in a specific campaign
Risk: write
markNotInterested
leads.markNotInterested
Mark lead as not interested across all campaigns
Risk: write
object[]
Output full type
Output full type
markNotInterestedInCampaign
leads.markNotInterestedInCampaign
Mark lead as not interested in a specific campaign
Risk: write
pause
leads.pause
Pause lead activity across campaigns or in a specific campaign
Risk: write
object[]
Output full type
Output full type
personalizeStep
leads.personalizeStep
Personalize step message for a single lead
Risk: write
content full type
content full type
resetStepPersonalization
leads.resetStepPersonalization
Reset step personalization for a single lead
Risk: destructive
resume
leads.resume
Resume a paused lead in all campaigns or one campaign, allowing outreach to continue
Risk: destructive
object[]
Output full type
Output full type
review
leads.review
Manually launch a lead into its campaign, allowing outreach to begin
Risk: destructive
skipStep
leads.skipStep
Skip one step of a running campaign for a single lead
Risk: destructive
unsubscribeFromCampaign
leads.unsubscribeFromCampaign
Unsubscribe a lead from a campaign by email
Risk: destructive
updateInCampaign
leads.updateInCampaign
Update lead information in a campaign
Risk: write
updateVariables
leads.updateVariables
Update custom variables of a lead
Risk: write
warnings full type
warnings full type
Team
get
team.get
Retrieve team details and members
Risk: read
hooks full type
hooks full type
users full type
users full type
getCredits
team.getCredits
Retrieve team remaining credits balance
Risk: read
details full type
details full type
getCrmUsers
team.getCrmUsers
List team members connected to CRM
Risk: read
object[]
Output full type
Output full type
getSenders
team.getSenders
Retrieve all team members and their associated campaigns
Risk: read
object[]
Output full type
Output full type
Unsubscribes
bulkUnsubscribeVariables
unsubscribes.bulkUnsubscribeVariables
Bulk unsubscribe variables up to 10,000 items
Risk: destructive
object \| string
Output full type
Output full type
exportContacts
unsubscribes.exportContacts
Export all contacts with their subscription status in CSV or JSON; filter for doNotContact true to get only opted-out contacts
Risk: read
object[] \| string
Output full type
Output full type
exportVariables
unsubscribes.exportVariables
Export unsubscribed variables in CSV or JSON format
Risk: read
object[] \| string
Output full type
Output full type
getContactStatus
unsubscribes.getContactStatus
Get subscription status of a contact
Risk: read
getVariable
unsubscribes.getVariable
Get unsubscribed status of a variable
Risk: read
listVariables
unsubscribes.listVariables
List unsubscribed variables (emails, domains, phones)
Risk: read
object[]
Output full type
Output full type
resubscribeContact
unsubscribes.resubscribeContact
Re-subscribe a contact by ID
Risk: write
string
resubscribeVariable
unsubscribes.resubscribeVariable
Re-subscribe a variable to allow future outreach
Risk: write
string
unsubscribeContact
unsubscribes.unsubscribeContact
Unsubscribe a contact by ID
Risk: destructive
string
unsubscribeVariable
unsubscribes.unsubscribeVariable
Unsubscribe a single variable (email, domain, or phone)
Risk: destructive