Send multiple Messages

post

https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/message-templates/{messageTemplateLookupId}/actions/send-to-list/{listLookupId}

Path Params

space

string

required

The name of the space (database) assigned to you.

messageTemplateLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

listLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

dim

string

The Dimensions under which the calling application operates. Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Body Params

subscriptionListId

string

Takes a Lookup Id. Required for Marketing messages, unless the Message Template contains a default Subscription List. If specified, overrides the Template's default. The Message will only be sent if the Member is opted in to the Subscription List. This attribute only has effect for marketing messages.

data

object

Optional Json data which may be needed for personalised messages. All Members in the List share the same data structure

sendAt

date-time

Optional timestamp for when the message should go out. The message is guaranteed not to be sent before this time, but may go out later if there are many messages in the queue. If left blank, it's simply added to the queue to be sent as soon as possible.

priority

int32

Provides the ability to override the Message Template's default priority by specifying a digit between 1 (highest) and 9 (lowest). Normally left blank.

Response

200

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!