triggerFolderDelay

post

https://mxm.xtremepush.com/api/json/email_send?method=triggerFolderDelay

Queue a Triggered Email in the same manner as triggerFolder but send to the recipient after a defined delay; optionally cancel any existing queued emails

The profile data is stored in the queue and is not set to the recipient until the delay period. This means any other changes that made to the recipient's profile data within the delay period will be overwritten for any fields contained in the profile data submitted with this method.

Form Data

folderId

integer

required

ID of the folder

emailAddress

string

required

Email address to be sent the Triggered Email

A new Recipient record will be created if it does not already exist. They will not be visible on any lists unless added by any regular list mechanism.

It's also possible to provide a Recipient ID for this parameter.

profileData

enum

required

Defaults to {}

Profile field values to set for the given recipient

The values are stored to the recipient's profile fields immediately before the email is sent, so they are available for any dynamic content within the message in the same manner as a regular email campaign. The values remain set against the recipient.

No profile data; empty object

delay

integer

required

1 to 21600

A time in seconds to delay the sending of this triggered email

cancelExisting

boolean

required

Defaults to false

Cancel any existing queued/delayed triggered emails for the matching folderId and recipient

Responses

200Returns boolean true on success

400Unexpected error