Broadcast messages

Use broadcast messages to notify customers and leads about upcoming promotions, service updates, and events. Broadcast messages are emails that are sent to a specific group of customers, or all customers. For more information, see Create a broadcast message.

Operations

Retrieve broadcast messages

Request

Retrieves a list of broadcast messages.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/broadcast-messages?limit=1000&offset=1000&sort=string&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of broadcast messages retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
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": [ … ]
  }
]