/
Retrieve a broadcast mess...

Retrieve a broadcast message

Request

Retrieves a broadcast message.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/broadcast-messages/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Broadcast message retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the broadcast message.

Example:"mail_bcst_0YV8XW5EXWDVEAP64XP8CY2X40"
filterstring or null

Use this filter to select customers during broadcast message processing.

This field uses the same syntax as the query filter, but without the filter= prefix. Examples: firstName:John, firstName:John;lastName:Doe.

Important: Do not URL encode the filter value.

Example:"firstName:John;lastName:Doe"
titlestring, <= 255 characters

Title of the message. This title displays in reports.

messagesArray of objects, non-emptyrequired

List of messages.

splitTestStartTimestring or null, (date-time)read-only

Date and time when the split test messages are scheduled to send.

startSendingTimestring, (date-time)required

Date and time when the message is scheduled to send.

statusstringread-only

Status of the broadcast message.

Enum:"draft""sending""sent""archived"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "mail_bcst_0YV8XW5EXWDVEAP64XP8CY2X40",
  "filter": "firstName:John;lastName:Doe",
  "title": "string",
  "messages": [
    { … }
  ],
  "splitTestStartTime": "2019-08-24T14:15:22Z",
  "startSendingTime": "2019-08-24T14:15:22Z",
  "status": "draft",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}