REST API

The REST API is a convenient alternative to the SOAP API that lets you also manage Smart Campaigns.

See also: REST API resource documentation

REST supports several standards and formats, such as HTTPS, URI, JSON and XML. You can retrieve data from and send data to Optimizely Campaign via REST API.

What can I do with the REST API?

You can execute virtually any function of Optimizely Campaign from a remote system without using the web browser and logging into your client manually, for example:

• Campaign management
  • Activate and start a Smart Campaign
  • Get report data of sent mailings
  • Create and send transactional messages
• Recipient management
  • Create recipient lists and add new recipients
  • Update blocklists or create a custom blocklist
  • Add recipients to an unsubscribe list
• Bounce management
  • Check the bounce status of recipients
  • Reset the bounce counter of a recipient

Services and operations

In total, Optimizely provides more than 200 operations for the Optimizely Campaign services listed below. For an overview of all resources and operations, see the Swagger resource documentation. See also Optimizely Campaign User Guide.

• Assets. Manage assets such as images.
• Attachments. Manage email attachments.
• Blacklist entries. Manage recipients on a blocklist.
• Confirmations. Manage registration confirmations (opt-in emails).
• Click profiles. Manage click profiles.
• Coupon blocks. Manage coupon blocks that organize coupon codes. ).
• Custom blacklists. Manage custom blocklists.
• Folders. Manage folders for mailings and message templates.
• Mail archive. Get archived mailings, such as opt-in emails and transactional mail. 
• Mail ID. Get information about a mail ID.
• Message templates. Manage message templates.
• Opt-in processes. View, update, and create opt-in processes.
• Recipient lists. View, copy, and update recipient lists.
• Recipients. Manage recipients.
• Responses. Manage mailing responses, such as hard or soft bounces.
• Scheduled jobs. Get information about scheduled jobs.
• Smart Campaigns. Manage Smart Campaigns.
• Transactional mails. Manage transactional mails that are triggered by a recipient action or event.
• Unsubscribes. Manage recipients on an unsubscribe list.
• Webhooks. Manage webhooks to export event data in real-time.