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.

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