Preview v1.2

Send a message preview to a single recipient without delay.

What can I do with preview?

Preview email and sms messages to ensure your campaign looks great before you send it out to all your subscribers!

  • Preview supports personalisation in messages.
  • If your message contains personalisation, try supplying a subscriber_id.
  • The message_id attribute accepts messages from both "email" and "sms" channels.
  • Check completed to see if the preview sent succesfully.

We highly recommend previewing messages before scheduling them to be sent. This will help you find issues before it's too late!

GET /preview or /preview/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the preview.
message_id
intYesNoUnique ID of the message to send.
user_id
intNoNoUnique ID of the creator.
subscriber_id
int/nullNoNoUnique ID of a subscriber - used for personalisation only. If personalisation exists then the Sign-Up.to platform will populate the message with this subscriber's data. If null or omitted, no personalisation will be applied.
recipient
stringNoNoThe preview recipient; email address or MSISDN (depending on the message_id's channel).
completed
boolRequiredNoWhether the preview has been sent.
cdate
decimalNoYesCreation timestamp.

Admin users may view previews sent by any user_id, however sub-users can only view previews sent by themselves.

HEAD /preview or /preview/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the preview.
message_id
intOptionalUnique ID of the message to send.
completed
boolRequiredWhether the preview has been sent.

POST /preview

AttributeTypePresenceDescription
message_id
intRequiredUnique ID of the message to send.
subscriber_id
int/nullOptionalUnique ID of a subscriber - used for personalisation only. If personalisation exists then the Sign-Up.to platform will populate the message with this subscriber's data. If null or omitted, no personalisation will be applied.
recipient
stringRequiredThe preview recipient; email address or MSISDN (depending on the message_id's channel).

There is no charge to preview messages in the "email" channel. However, there is a limit on the number of previews sent in a 24 hour period (50).

You will be charged one or more SMS credits for preview messages in the "sms" channel, depending on the length of your message_id. See smsMessage for more information on character limits and cost.

PUT /preview or /preview/:id

This method is not supported.

DELETE /preview or /preview/:id

This method is not supported.

Examples

JSON response

{
    "id":                 87654321,
    "message_id":         123456,  
    "user_id":            123,   
    "subscriber_id":      null,
    "recipient":          "mailbox@example.com",
    "completed":          true,   
    "cdate":              1234966741,
}