Service Messages

POST /servicemessage/send

❗️

This documentation is no longer supported

For the latest information on our API, see Getting Started with the RedEye API

Send a simple email or SMS campaign Schedule

This service uses the send command for both email and SMS messages. You can send a schedule to an individual recipient or up to a maximum of 10,000 recipients of your choice by email or Short Message Service (SMS).

Generally this is the quickest method of sending emails because unlike the RAPID service, this is a simple service that sends a campaign directly to the email / SMS provider without checking permits, storing data or tracking email performance about specific individuals. This operation stores the following details about the email:

• Sent status
• Delivery status
• Open status (for emails)
• Unique open status, for example; the email was opened ten times by the same individual

🚧

Warning: Do not use servicemessage for marketing purposes. Recipient marketing preferences are not checked when the requests are processed.

If there is at least one email address in the batch with an incorrect format, the whole batch of recipients will fail to send.

Prerequisites:

Before you can use this service you need to make sure that you've completed the following tasks:

• Created a schedule in Contour
• Received the relevant credentials from your RedEye account manager
• Allowed no more than 350 merges in an email schedule

📘

During a request, the service message service does the following:

• All requests are sent to the recipient regardless of any preferences.
• Uses request parameters in Creative merge fields
• If a service message creative contains merge fields then the request must contain all the merge field parameters to be used in the email.
• The email to send to the recipient is identified by the schedule name and must have been created in Contour prior to sending a service message request.
• The same recipient can be included more than once in the send and no deduplication will occur
  Service messages are batched and queued to improve efficiency and to prevent loss of data

SMS Handling

• You cannot have spaces or hyphens in the mobile number
• Works with or without the + sign
• International numbers are supported
• An invalid mobile number will still be charged even though the SMS will not be received

📘

URL: https://api.redeye.com/[client_id]/servicemessage/send/

Body Sample

{  
  "schedule": "string",  
  "reference": "string",  
  "recipient": [  
    {  
      "email": "string",  
      "mobile": "string",  
      "firstname": "string",  
      "titlelastname": "string",  
      "lastname": "string",  
      "title": "string",  
      "fullname": "string",  
      "carowner": "string",  
      "computerusers": "string",  
      "custrefid": "string",  
      "custrefnum": "string",  
      "ordernumber": "string"  
    }  
  ]  
}

Body Schema

{} SmBody
Schedulestring: The name of the schedule to send.
Referencestring: User defined value to uniquely identify the request. Subsequent requests using the same reference returns the original response and will not be re-processed.
Recipient array[SmFields]

{} SmFields
emailstring(optional): Email address
mobile string(optional)
firstname string(optional)
titlelastname string(optional)
lastname string(optional)
title string(optional)
fullname string(optional)
carowner string(optional)
computerusers string(optional)
custrefid string(optional)
custrefnum string(optional)
ordernumber string(optional)

Response Sample

{  
  "txId": "string",  
  "status": "string"  
}

Response Schema

{} ServiceMessageSuccess
txIdstring: Your unique reference ID from the original request.
statusstring: The status of the request.