Send a transactional mail

post

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

Send a transactional mail. You can specify attachment token or recipient data.

Path Params

clientId

string

required

Client ID

transactionalMailId

int64

required

Transactional mail ID

Form Data

personalizedAttachmentsToken

string

Token of the attachment to be sent

data

string

Recipient data. Configure "data.[attribute]" according to the corresponding recipient list field.
Example:
data.firstname: John
data.lastname: Smith
data.email: [email protected] (only required if the email list field is not the address field)

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

recipientId

string

required

Email address or telephone number (for SMS). In case the id field is the address field in the recipient list the recipientId is sufficient. If not you have to provide the address in the request body.

recipientListId

int64

required

Transactional recipient list to which the recipient will be added

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

The required recipientId/recipientListId is not provided and the recipient list is not assigned to the mailing. Add the required parameters and try again.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.optivo.broadmail.v1+json

202The transactional mail was accepted and is sent asynchronously. To retrieve the sending status of the transactional mail, use the returned mailId and the GET status operation.