Retrieve broadcast messages

Retrieves a list of broadcast messages.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

List of broadcast messages retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array
startSendingTime
required
string <date-time>

Date and time when the message is scheduled to send.

id
string <= 50 characters

ID of the broadcast message.

filter
string

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.

title
string

Title of the message. This title displays in reports.

Array of objects non-empty

List of messages.

Array (non-empty)
required
Array of objects non-empty

Split test templates.

Use split tests to determine which content is most effective. Split tests send variations of the same message to different customers or leads. You can then send the winning message to the remaining customers or leads.

id
string <uuid>

ID of the message.

version
string

Version number of the message. Use this field to distinguish between multiple messages by name and version number. If there are no versions, this field is empty.

weight
integer [ 0 .. 100 ]
Default: 100

Weight distribution value that is assigned to a template for a split test. Each template in a split test can be assigned a weight. The higher the weight value, the more likely the message template is used.

The split test algorithm does not assess locale when making a weighted template selection.

splitTestStartTime
string <date-time>

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

status
string

Status of the broadcast message.

Enum: "draft" "sending" "sent" "archived"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/broadcast-messages
Request samples
Response samples
application/json
[
  • {
    }
]