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

REST API

Use the REST API to integrate Episerver Campaign features into your software or manage and control them remotely by using HTTP requests. The REST API is a convenient alternative to the SOAP API that lets you also manage Smart Campaigns.

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

In this topic

What can I do with the REST API?

You can execute virtually any function of Episerver 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 mails
  • Recipient management
    • Create recipient lists and add new recipients
    • Update blacklists or create a custom blacklist
    • 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, Episerver provides more than 200 operations for the Episerver Campaign services listed below. For an overwiew of all resources and operations, see the Swagger REST API documentation.

Setting up the REST API in your client

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

Provide a separate email address that you do not yet use for Episerver Campaign. This address must use the same domain as your Campaign user login and should not be personalized, for example api-user@company.com.

You should also have access to the inbox of this address, as Episerver will send an activation mail. Using that email address, customer support will set up your API user.

Note: Do not log in to the Episerver Campaign front end by using your API user credentials. API users only have access to services and operations needed for API purposes.

Authentication

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

To use the Try it out feature in Swagger, click Authorize and enter Basic User:Password in the value field.
Basic is part of the authentication; User:Password must be Base64 encoded.

Information regarding general use

Data transmission and representation

The REST API only accepts HTTPS requests. The base URL for all requests is as follows:

https://api.campaign.episerver.net/rest/{clientId}/{component}/{path}/{parameters}

The response data is transferred as a JSON string.

Response example

{
  "id": "string",
  "created": "2020-03-04T13:30:52.073Z",
  "modified": "2020-03-04T13:30:52.073Z",
  "optInMailId": "string",
  "links": [
    {
      "params": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "rel": "string",
      "uriBuilder": {},
      "uri": "string",
      "rels": [
        "string"
      ],
      "title": "string",
      "type": "string"
    }
  ]
}

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

Finding IDs

After customer support has set up an API client, you can find the client ID in Episever Campaign under Administration > API overview > REST API.

API overview

See also API overview in the Episerver User Guide.

Campaign ID, mailing ID, confirmation ID etc. are documented in the corresponding list in Episever Campaign.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Mar 19, 2020