Loading...
Area: Episerver Campaign
Applies to versions: Not applicable

REST API

Using the REST API in Episerver Campaign, you can perform an HTTPS request to control the following functions remotely:

  • Smart Campaigns: Create, edit and send one-shot campaigns, e.g. newsletters
  • Confirmations: Edit and send registration confirmations (opt-in-mails)
  • Transactional mails: Create transactional mails that are automatically triggered by actions or events

You can find information on these functions in the following chapters:

Set up the REST API in your client

To set up the REST API in your client, contact customer service.

Note: For setting up the REST API, provide a separate email address that you do not yet use for Episerver Campaign. Using that email address, Episerver customer support will set up your API user.
In contrast to Campaign standard users, API users only have access to services and methods needed for API purposes. This is due to security reasons.

Data transmission/representation

The REST API only accepts HTTPS requests. The response data is transferred as a JSON string.

Authentication

The authentication is done via Basic Authentication with the API user and API password that customer support has set up for you.

Date format

Specify data in the ISO-8601 format: YYYY-MM-DDTHH: MM: SSZ

Examples:

2018-05-25T18: 08: 55 + 02: 00
2018-05-25T20: 08: 55Z

Swagger documentation

For a description of the methods and resources, see the Swagger documentation here.

Last updated: Mar 12, 2019

Feedback?