DIY Surveys / API
  • Welcome to the DIY Surveys API
  • Getting Started
  • Messaging
    • Keyword
    • Languages
    • GSM Character Set
    • Macros
      • Macro Reference
    • Message Statuses
    • Message Windows
    • Metadata
    • Stop Lists
    • Usage
    • Message Type
  • Organizations
  • Recipient
  • Security
  • Survey
  • TinyUrl
  • Web Hooks and Callbacks
  • Custom Transformations
  • FAQ
  • Cloud Service
  • API Versions
    • DIY Surveys API 1.0
    • DIY Surveys API 2.0
    • DIY Surveys API 3.0
Powered by GitBook

Services

  • Surveys
  • Respondents
  • Results
  • Channels

© 2025 DIY Surveys Ltd.

On this page
  • Messages
  • Recipients
  • Surveys

Was this helpful?

  1. Messaging
  2. Macros

Macro Reference

PreviousMacrosNextMessage Statuses

Last updated 1 year ago

Was this helpful?

This section contains a full list of macros that can be used with the DIY Surveys API. Please check 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 (as denoted with the brackets) and if supplied will override the default tinyurl of the platform. The tinyurl supplied must exist in the uses account and be set up correct 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

surveydescritpion

{surveydescriptions}

the description of the survey

here