Automations
deliverabilityRate
automations.deliverabilityRate
List automation deliverability
Risk: read
items full type
items full type
_links full type
_links full type
linksTracking
automations.linksTracking
List automation link tracking
Risk: read
items full type
items full type
_links full type
_links full type
list
automations.list
List automations
Risk: read
items full type
items full type
_links full type
_links full type
opensAndClicks
automations.opensAndClicks
List automation opens and clicks
Risk: read
items full type
items full type
_links full type
_links full type
summary
automations.summary
Get automation summary
Risk: read
detail full type
detail full type
_links full type
_links full type
unsubscribeActivity
automations.unsubscribeActivity
List automation unsubscribe activity
Risk: read
items full type
items full type
_links full type
_links full type
Campaigns
approve
campaigns.approve
Approve a campaign
Risk: write
_links full type
_links full type
create
campaigns.create
Create a campaign
Risk: write
campaign full type
campaign full type
_links full type
_links full type
createShipping
campaigns.createShipping
Send or schedule a campaign (emails its recipients)
Risk: destructive
shipping full type
shipping full type
_links full type
_links full type
delete
campaigns.delete
Delete a campaign
Risk: destructive
_links full type
_links full type
deleteShipping
campaigns.deleteShipping
Cancel a scheduled campaign delivery
Risk: destructive
_links full type
_links full type
deleteTextAlternative
campaigns.deleteTextAlternative
Delete campaign text alternative
Risk: destructive
_links full type
_links full type
deliveries
campaigns.deliveries
List campaign deliveries
Risk: read
items full type
items full type
_links full type
_links full type
get
campaigns.get
Get a campaign
Risk: read
_links full type
_links full type
getContent
campaigns.getContent
Get campaign HTML content
Risk: read
string
getRecipients
campaigns.getRecipients
Get campaign recipients
Risk: read
lists full type
lists full type
segments full type
segments full type
_links full type
_links full type
getShipping
campaigns.getShipping
Get a scheduled campaign delivery
Risk: read
_links full type
_links full type
getSocial
campaigns.getSocial
Get campaign social preferences
Risk: read
facebookPagesPost full type
facebookPagesPost full type
_links full type
_links full type
getTextAlternative
campaigns.getTextAlternative
Get campaign text alternative
Risk: read
_links full type
_links full type
list
campaigns.list
List campaigns
Risk: read
items full type
items full type
_links full type
_links full type
preview
campaigns.preview
Preview campaign content
Risk: read
string \| custom
resultsSummary
campaigns.resultsSummary
Get campaign results
Risk: read
_links full type
_links full type
unsubscribed
campaigns.unsubscribed
List campaign unsubscribers
Risk: read
items full type
items full type
_links full type
_links full type
update
campaigns.update
Update a campaign
Risk: write
campaign full type
campaign full type
_links full type
_links full type
updateContent
campaigns.updateContent
Update campaign HTML content
Risk: write
_links full type
_links full type
updateRecipients
campaigns.updateRecipients
Update campaign recipients
Risk: write
recipients full type
recipients full type
_links full type
_links full type
updateSocial
campaigns.updateSocial
Update campaign social preferences
Risk: write
_links full type
_links full type
updateTextAlternative
campaigns.updateTextAlternative
Update campaign text alternative
Risk: write
textAlternativeContent full type
textAlternativeContent full type
_links full type
_links full type
Fields
list
fields.list
List subscriber field definitions
Risk: read
items full type
items full type
_links full type
_links full type
Home
account
home.account
Get the account API home
Risk: read
_links full type
_links full type
get
home.get
Get the API home
Risk: read
_links full type
_links full type
Integrations
delete
integrations.delete
Delete integration access
Risk: destructive
_links full type
_links full type
get
integrations.get
Get integration access
Risk: read
_links full type
_links full type
update
integrations.update
Update integration access
Risk: write
thirdPartyAppAccess full type
thirdPartyAppAccess full type
_links full type
_links full type
Lists
create
lists.create
Create a subscriber list
Risk: write
list full type
list full type
_links full type
_links full type
delete
lists.delete
Delete a subscriber list
Risk: destructive
_links full type
_links full type
get
lists.get
Get a subscriber list
Risk: read
_links full type
_links full type
list
lists.list
List subscriber lists
Risk: read
items full type
items full type
_links full type
_links full type
update
lists.update
Update a subscriber list
Risk: write
list full type
list full type
_links full type
_links full type
Subscribers
archive
subscribers.archive
Archive a subscriber
Risk: write
_links full type
_links full type
associate
subscribers.associate
Associate a subscriber with a list
Risk: write
subscriber full type
subscriber full type
_links full type
_links full type
create
subscribers.create
Create or update a subscriber
Risk: write
subscriber full type
subscriber full type
_links full type
_links full type
deliveries
subscribers.deliveries
List subscriber campaign deliveries
Risk: read
items full type
items full type
_links full type
_links full type
doubleOptIn
subscribers.doubleOptIn
Associate a subscriber using double opt-in (emails the subscriber)
Risk: destructive
subscriber full type
subscriber full type
_links full type
_links full type
exists
subscribers.exists
Check whether a subscriber exists
Risk: read
boolean
get
subscribers.get
Get a subscriber
Risk: read
fields full type
fields full type
listsHistory full type
listsHistory full type
_links full type
_links full type
import
subscribers.import
Import account subscribers
Risk: write
subscribers full type
subscribers full type
_links full type
_links full type
importCsv
subscribers.importCsv
Import subscribers from CSV
Risk: write
_links full type
_links full type
importToList
subscribers.importToList
Import subscribers into a list
Risk: write
subscribers full type
subscribers full type
_links full type
_links full type
importUnsubscribed
subscribers.importUnsubscribed
Import unsubscribed subscribers
Risk: destructive
subscribers full type
subscribers full type
_links full type
_links full type
list
subscribers.list
List account subscribers
Risk: read
items full type
items full type
_links full type
_links full type
listByOrigin
subscribers.listByOrigin
List subscribers by origin
Risk: read
items full type
items full type
_links full type
_links full type
listForList
subscribers.listForList
List subscribers in a list
Risk: read
items full type
items full type
_links full type
_links full type
listUnsubscribed
subscribers.listUnsubscribed
List unsubscribed subscribers
Risk: read
items full type
items full type
_links full type
_links full type
permissionsHistory
subscribers.permissionsHistory
Get subscriber permission history
Risk: read
items full type
items full type
_links full type
_links full type
removeFromList
subscribers.removeFromList
Remove a subscriber from a list
Risk: write
_links full type
_links full type
unsubscribe
subscribers.unsubscribe
Unsubscribe a subscriber from the account
Risk: destructive
subscriber full type
subscriber full type
_links full type
_links full type
Tasks
get
tasks.get
Get a task
Risk: read
_links full type
_links full type
importErrors
tasks.importErrors
List task import errors
Risk: read
items full type
items full type
_links full type
_links full type
list
tasks.list
List account tasks
Risk: read
items full type
items full type
_links full type
_links full type
Templates
create
templates.create
Create a double opt-in template
Risk: write
template full type
template full type
_links full type
_links full type
get
templates.get
Get a double opt-in template
Risk: read
_links full type
_links full type
updateContent
templates.updateContent
Update double opt-in template HTML
Risk: write
_links full type
_links full type