Create a mailing

post

https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages

Create a Smart Campaign mailing and specify information such as sender address, name, content (plain text) or media code.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client ID

campaignId

int64

required

Smart Campaign ID

Form Data

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

resetTargetedSubjects

boolean

If true, all target group subjects are deleted (only email)

replyToName

string

Reply-to mailing name (only email)

resetDeeplinks

boolean

This parameter is deprecated. Use "resetPayload" instead.

resetPayload

boolean

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

name

string

Mailing name

content

string

Mailing content (plain text)

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)

subject

string

Mailing subject

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

senderAddress

string

Mailing sender address

clickAction

string

Click action for the Web Push message

pushType

string

enum

Push type

Allowed:

icon

string

Icon for the Web Push message

predecessorNodeId

string

Predecessor node

successorNodeId

string

Successor node

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

201The mailing was created successfully.