Messages can be created with this API to manually send notifications to a specified set of recipients.
Error handling
This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.
Methods
createMessage
Sends the supplied message to the defined recipients
POST /messages/v1
Request
Custom Headers
Accept
string
Allowable values: [application/json,text/plain]
Request Body
Required*
MessagePayload
Message payload
Recipients
Required*
Who to send the message to
Subject
Required*
string
The subject of the message (maximum of 80 characters)
Possible values: length ≤ 80
Message
Required*
string
The message to be sent (maximum of 1500 characters)
Possible values: length ≤ 1500
Metadata
Metadata
any property
Response
Response Body
Message
ShortId
Always included*
string
Unique user-facing identifier
Message
Always included*
string
Message sent
Subject
Always included*
string
Message subject
Recipients
Always included*
The contacts that were sent the message
InternalTime
Always included*
integer
Internal server system time the message was posted
Status Code
200
Successful request
400
Invalid request
415
Invalid media type
No Sample Response
This method does not specify any sample responses.
getMessageByShortId
Gets a message
GET /messages/v1/{id}
Request
Custom Headers
Accept
string
Allowable values: [application/json,text/plain]
Path Parameters
id
Required*
string
Short Message ID
Response
Response Body
Message
ShortId
Always included*
string
Unique user-facing identifier
Message
Always included*
string
Message sent
Subject
Always included*
string
Message subject
Recipients
Always included*
The contacts that were sent the message
InternalTime
Always included*
integer
Internal server system time the message was posted
Status Code
200
Successful request
404
Unable to locate message
No Sample Response
This method does not specify any sample responses.