Broadcast Messages

Retrieve a list of broadcast messages

Retrieve a list of broadcast messages.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of broadcast messages was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/broadcast-messages
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/broadcast-messages?limit=1000&offset=0&sort=string&filter=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a broadcast message

Create a broadcast message.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Broadcast message resource.

filter
string

The filter that will be used on customer selection during the broadcast message processing. The syntax is the same as the query filter, without filter= prefix. For example: firstName:John, firstName:John;lastName:Doe, etc. Attention: You should not URL encode the filter value.

title
string

The title of the messages (this title will appear in reports).

Array of objects non-empty

The list of messages.

Array (non-empty)
id
string <uuid>

The message identifier string.

version
string

The message version (by default is empty, but if you make multiple versions, you can name or number them to distinguish them).

weight
integer [ 0 .. 100 ]
Default: 100

The value for random-weighted picking of a template in the case of a split test. The split test algorithm does not factor localization when making a weighted-random template selection. Therefore, a version will be selected first, and then after a version is selected a specific localization will be selected. Take the case where two versions have different locale content -- the locales of the content is not considered when selecting the version.

required
Array of objects non-empty

The value for random-weighted picking of a template in the case of a split test. The split test algorithm does not factor localization when making a weighted-random template selection. Therefore, a version will be selected first, and then after a version is selected a specific localization will be selected. Take the case where two versions have different locale content -- the locales of the content is not considered when selecting the version.

startSendingTime
required
string <date-time>

The start sending time.

Responses
201

Broadcast message was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/broadcast-messages
Request samples
application/json
{
  • "filter": "firstName:John;lastName:Doe",
  • "title": "string",
  • "messages": [
    ],
  • "startSendingTime": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}

Retrieve a broadcast message

Retrieve a broadcast message.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Broadcast message with specified identifier was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/broadcast-messages/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/broadcast-messages/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}

Delete a broadcast message

Delete a broadcast message.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Broadcast message was deleted.

delete/broadcast-messages/{id}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/broadcast-messages/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Update a broadcast message

Update a broadcast message.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Broadcast message resource.

filter
string

The filter that will be used on customer selection during the broadcast message processing. The syntax is the same as the query filter, without filter= prefix. For example: firstName:John, firstName:John;lastName:Doe, etc. Attention: You should not URL encode the filter value.

title
string

The title of the messages (this title will appear in reports).

Array of objects non-empty

The list of messages.

Array (non-empty)
id
string <uuid>

The message identifier string.

version
string

The message version (by default is empty, but if you make multiple versions, you can name or number them to distinguish them).

weight
integer [ 0 .. 100 ]
Default: 100

The value for random-weighted picking of a template in the case of a split test. The split test algorithm does not factor localization when making a weighted-random template selection. Therefore, a version will be selected first, and then after a version is selected a specific localization will be selected. Take the case where two versions have different locale content -- the locales of the content is not considered when selecting the version.

required
Array of objects non-empty

The value for random-weighted picking of a template in the case of a split test. The split test algorithm does not factor localization when making a weighted-random template selection. Therefore, a version will be selected first, and then after a version is selected a specific localization will be selected. Take the case where two versions have different locale content -- the locales of the content is not considered when selecting the version.

startSendingTime
required
string <date-time>

The start sending time.

Responses
200

Broadcast message was updated.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

patch/broadcast-messages/{id}
Request samples
application/json
{
  • "filter": "firstName:John;lastName:Doe",
  • "title": "string",
  • "messages": [
    ],
  • "startSendingTime": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}