Loading...

Last updated: May 28 2018

Area: Episerver Campaign Applies to versions: Not applicable

HTTP API

The HTTP API of Episerver Campaign is an easy to configure and use interface, which can be used to execute the most common functions with an HTTP request. If a user clicks on a button or a link on a website or in an email (e.g. Send registration), a specific URL is called and the parameters are submitted. This URL contains an action to be executed (e.g. sendEventMail) and further parameters (e.g. recipient ID, mailing ID). The API server reads these parameters and calls the requested action.

What can I do with the HTTP API?

Use the HTTP API to integrate online forms, for example registration forms for new subscribers. It it also suitable to send triggered emails, such as order confirmations or invoices. The following functions can be used with the HTTP API:

  • Create new recipients
  • Send triggered emails
  • Blacklist recipients
  • Unsubscribe recipients

Modifications since the previous version

The bmOptinFrequencyLimit parameter has been added to the subscribe operation.


Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/