Last updated: Apr 25 2018

Area: Episerver Campaign Applies to versions: Not applicable

Services and operations

This topic describes the services and operations used in the HTTP integration API for Episerver Campaign.

Form service

The form service is used for the integration of forms (e.g. a registration form). The form service is linked by an authorization code to a specific recipient list. All operations within this service relate to this recipient list. Since the form service is usually used by a single server, we recommend to always use IP security. To select the form service, enter the service selector value form. For example:

http://api.campaign.episerver.net/http/form/....

Mail service

The mail service is used for the integration of profile updates by email. You can add personal data to the recipients' profiles or move them to another list. Since the mail service is used by multiple users, IP security is not possible. The authorization code generated by the system is protected by a checksum against tampering. To select the mail service, enter the service selector value mail. Instead of an authorization code, insert the placeholder {bmMailId}, which is automatically replaced in each email by a value. For example:

http://api.campaign.episerver.net/http/mail/{bmMailId}/unsubscribe

Operations

The following topics describe the operations in more detail. To select one of these operations, use the name of the operation as the operation selector.

Note: Not all operations are available in both services (mail and form).

OperationDescription

blacklist and unblacklist

Generate or remove a blacklist entry.

copy and move

Copy or move a recipient from one recipient list to another.

createtrackingoptout and deletetrackingoptout

Let you deactivate and reactivate the use of action-based data for a recipient.

getsendstatus

Queries sending details for emails that have been sent using one of the two operations: sendeventmail or sendtransactionmail.

nop

No function.

onlineversion

Shows a personalized online version of a mailing.

remove

Removes a recipient from a recipient list.

sendeventmail

Sends an event mailing to a single recipient.

sendtransactionmail

Creates a new recipient and sends an event mailing to this recipient.

subscribe

Adds a new recipient to a recipient list or updates an existing recipient.

unsubscribe

Unsubscribes a recipient from a recipient list.

updatefields

Updates recipient data fields.

uploadpersonalizedattachments

Uploads one ore more attachments.

Comments