Skip to content

Macro Reference

This section contains a full list of macros that can be used with the DIY Surveys API. Please check here for more information on how macros can be used.

Messages

The following macros can be used when sending a message:

Name Format Description
source {source} The source the message was sent from.
destination {destination} The destinations the message will be sent to.
brand {brand(name)} The branding to apply to the source if the network allows it.
tiny {tiny(long[,tiny])} The ability to turn a long URL into a tiny URL. The Tiny URL is optional and, if supplied, will override the default tiny URL of the platform. The tiny URL supplied must exist in the user's account and be set up correctly for it to work.

Recipients

The following macros can be used when sending a message that refers to a recipient:

Name Format Description
first {first} the first name of a recipient
last {last} the last name of a recipient
telno {telno} the mobile number associated with the recipient

Surveys

The following macros can be used when sending a message that is associated with a recipient within a survey. This includes all of the above macros in the recipients list and the following:

Name Format Description
surveyname {surveyname} the name of the survey
surveydescription {surveydescription} the description of the survey