/
Create a broadcast messag...

Create a broadcast message

Request

Creates a broadcast message.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Broadcast message resource.

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.

startSendingTimestring, (date-time)required

Date and time when the message is scheduled to send.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/broadcast-messages \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "filter": "firstName:John;lastName:Doe",
    "title": "string",
    "messages": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "version": "string",
        "weight": 75,
        "templates": [
          {
            "from": "example@example.com",
            "subject": "Demonstration subject",
            "text": "Demonstration text",
            "html": "<p>Demonstration text</p>",
            "locale": "fr-FR"
          }
        ]
      }
    ],
    "startSendingTime": "2019-08-24T14:15:22Z"
  }'

Responses

Broadcast message created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
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": [
    { … }
  ]
}