API Reference

Send a Message

post
https://neon-loyalty-qa.spika.com/loyalty/v1//message-templates//actions/send
Path Params
string
required

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

string
required

One of:

  • The Entity's internal Entity Id
  • The Entity's name
  • The Entity's business Id, prefixed with $
Query Params
string

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

boolean

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

boolean
Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params
string
required

Member Lookup Id to send to

string

If specified, overrides the Member's default destination (email or mobile). Normally left blank, but useful when sending test messages.

boolean

Set to true to flag the message as a test message.

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

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.

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

Updated 10 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago