Create a transactional mail

post

https://api.campaign.episerver.net/rest/{clientId}/transactionalmail

Create a transactional mail and add information such as subjects for target groups, media code or successor and predecessor node.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client ID

Form Data

recipientListIds

array of int64s

required

Comma-separated list of recipient list IDs

recipientListIds*

content

string

required

Mailing content (plain text)

subject

string

required

Mailing subject

senderAddress

string

required

Mailing sender address

deepLinkName

string

This parameter is deprecated. Use "payload.[name]" instead.

mediaType

string

enum

Media type of the mailing (required only for creation)

Allowed:

subjectForTargetGroup

string

Subject for a specific target group. Set "subject.[targetGroupId]" in request data (only email).

Does not work with the "Try it out" feature.

replyToAddress

string

Reply-to address (only email)

archiveEnabled

boolean

Toggle whether a mailing can be archived or not

iconMetaData

string

Icon meta data. Configure "icon.[attribute]".

Does not work with the "Try it out" feature.

archivePeriod

string

enum

Period suggesting for how long a mailing should be archived

Allowed:

resetReplyToAddress

boolean

If true, the local part of the reply-to address is reset

replyToName

string

Reply-to mailing name (only email)

resetPayload

boolean

If true, all payload parameters are deleted. All set parameters within this request remain (only Web Push mailings).

name

string

Mailing name

payload

string

Payload parameters for Mobile Push and Web Push. Set "payload.[name]" in request data.

Does not work with the "Try it out" feature.

description

string

Mailing description

senderName

string

Mailing sender name (only email)

mediaCode

string

Media code (only email)

expiry

date-time

Expiry date (only push mailings, use ISO 8601 format without milliseconds, e.g. 2022-03-03T08:45:07+01:00)

image

string

Image for the Web Push message

clickAction

string

Click action for the Web Push message

pushType

string

enum

Push type

Allowed:

icon

string

Icon for the Web Push message

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

The transactional mail could not be created. Ensure that the required parameters such as "recipientListIds", "mediaType", "subject", "senderAddress" or "content" are correctly added to the request.

201The transactional mail was created successfully.