Check whether a recipient is opted in or not

Check status optin of given recipient

The recipient's optin status was retrieved successfully.

<p>The recipient list is not of type opt-in</p>

The recipient could not be found. Ensure that the required parameters such as "recipientId" and "recipientListId" are correct and the recipient exists.

Delete a recipient from a recipient list

ai_cta

ai_identity

ai_chat

ai_product


Data set that refers to a person or a role and contains at least one address via which the person or role can receive messages.

recipient

Check whether a recipient is valid

Campaign API

Get the total number of images

Get information about all images

Upload an image

Get information about an image

Update the image name

Delete an image

Assets

Get the total number of attachments

Get information about all attachments

Create an attachment

Get the content of an uploaded attachment

Update the content of an uploaded attachment

Get information about an attachment

Update attachment information

Delete an attachment

Attachments

Create a personalized attachment

Personalized Attachments

Check whether an address is blocklisted

Get the total number of blocklist entries

Get information about all blocklist entries

Create a blocklist entry

Delete multiple blocklist entries

Get information about a blocklist entry

Delete a blocklist entry

Blocklist entries

Get information about all confirmation mailings

Create a confirmation mail

Get information about a confirmation mailing

Delete a confirmation mailing

Update a mailing

Add attachments into a campaign message. Only applicable for campaign message of type email

Delete attachments of a campaign message. Only applicable for campaign message of type email

Get the content of a mailing (email)

Get information about the sending status of all recipients of a test mailing

Get information about a tracking link of a mailing

Update the tracking link configuration of a mailing

Get information about all tracking links of a mailing

Get information about the tracking configuration of a mailing

Update the tracking configuration of a mailing

Get information about a "Recipients" node

Create or update a "Recipients" node

Send a test mailing

Get a campaign report

Start a confirmation mailing

Stop a confirmation mailing

Confirmations

Get information about all Smart Campaigns

Create or copy a Smart Campaign

Activate a Smart Campaign

Deactivate a Smart Campaign

Get information about a Smart Campaign

Update the name of a Smart Campaign

Delete a Smart Campaign

Get information about a "A/B test" node of a Smart Campaign

Create or update an "A/B test" node of a Smart Campaign

Delete an "A/B test" node of a Smart Campaign

Get information about a connection from an "A/B test" node

Create or update a connection from a "A/B test" node

Delete a connection from a "A/B test" node to another node

Get information about all connections from an "A/B test" node

Delete all connections from the "A/B test" node to other nodes

Get analysis data of a Smart Campaign

Schedule new recipient analysis for a Smart Campaign

Cancel a running recipient analysis of a Smart Campaign

Get information about a "Block" node of a Smart Campaign

Create or update a "Block" node of a Smart Campaign

Delete a "Block" node of a Smart Campaign

Get information about a "Limit" node of a Smart Campaign

Create or update a "Limit" node of a Smart Campaign

Delete a "Limit" node of a Smart Campaign

Get information about all mailings of a Smart Campaign

Create a mailing

Get information about a mailing

Delete a mailing

Update the content of a mailing

Delete the content of a mailing (email)

Pause a mailing

Start a mailing

Stop a mailing

Get information about all "Wait" nodes of a Smart Campaign

Create a new "Wait" node in a Smart Campaign

Get information about a "Wait" node of a Smart Campaign

Update a "Wait" node in a Smart Campaign

Delete a "Wait" node in a Smart Campaign

Get information about all "Target groups" nodes of a Smart Campaign

Create or update a "Target groups" node of a Smart Campaign

Delete all "Target groups" nodes of a Smart Campaign

Get information about a "Target groups" node of a Smart Campaign

Delete a "Target groups" node of a Smart Campaign

Get information about all "Throttle" nodes of a Smart Campaign

Create a new "Throttle" node in a Smart Campaign

Get information about a "Throttle" node of a Smart Campaign

Update a "Throttle" node of a Smart Campaign

Delete a "Throttle" node in a Smart Campaign

Pause a Smart Campaign

Start a Smart Campaign

Cancel a Smart Campaign

Smart Campaigns

Get information about all transactional mails

Create a transactional mail

Get information about a transactional mail

Delete a transactional mail

Send a transactional mail

Start a transactional mail

Stop a transactional mail

Get the sending status of a sent transactional mail

Transactional mails

Get information about all click profiles

Create a new click profile

Get links a click profile is assigned to

Assign links to a click profile

Unassign specific links from  a click profile

Get information about a click profile

Update a click profile

Click profiles

Get information about all coupon blocks

Create a new coupon block

Get information about a coupon block

Delete a coupon block

Get information about coupon codes

Create a list of coupon codes

Delete coupon codes

Get information about a coupon code

Invalidate a coupon code

Delete a coupon code

Get all mailing IDs a coupon block is assigned to

Coupon blocks

Get information about all custom blocklists

Create a custom blocklist

Get information about all entries of a custom blocklist

Create custom blocklist entries

Delete all entries from a custom blocklist

Get information about a custom blocklist entry

Update a custom blocklist entry

Delete a custom blocklist entry

Get information about a custom blocklist

Update a custom blocklist

Custom blocklists

Get information about all configured scheduled jobs

Get information about all running scheduled jobs

Scheduled jobs

Get information about all folders

Create a folder

Assign to an entity

Get information about a folder

Update a folder

Delete a folder

Unassign from an entity

Folders

Get information about an archived mailing

Get information about all archived mailings

Get the content of an archived mailing

Get compressed file with archived mailing contents

Mail archive

Get information about a mail ID

Get information about a plain mail ID (contains only mailing id)

Retrieve a mail ID

Mail ID

Get information about all message templates

Create or copy a message template

Get information about a message template

Update a message template

Delete a message template

Test a message template

Message templates

Get information about all opt-in processes

Create an opt-in process

Get information about an opt-in process

Update an opt-in process

Opt-in processes

Get information about all recipient lists

Copy a recipient list

Get information about a recipient list

Update a recipient list

Get the attribute names of a recipient list

Get the fields of a recipient list

Recipient lists

Get information about all recipients in a recipient list

Add multiple recipients to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see <a href="https://support.optimizely.com/hc/en-us/articles/4413192291981#prioritization">Opt-in documentation</a>).

Add a recipient to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see <a href="https://support.optimizely.com/hc/en-us/articles/4413192291981#prioritization">Opt-in documentation</a>).