Rebilly API Docs

Update a broadcast message

Updates a broadcast message with a specified ID.

SecuritySecretApiKey or JWT

Request

path Parameters

required

string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Broadcast message resource.

startSendingTime

required

string <date-time>

Date and time when the message is scheduled to send.

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.

Responses

200

Broadcast message updated.

Response Schema: application/json

startSendingTime

required

string <date-time>

Date and time when the message is scheduled to send.

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 (SelfLink)

Related links.

Array

href	string Link URL.
rel	string Type of link. Value: "self"

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

patch/broadcast-messages/{id}

Request samples

application/json

{"filter": "firstName:John;lastName:Doe",
"title": "string",
"messages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"weight": 75,
"templates": [{"from": "example@example.com",
"subject": "Sujet de démonstration",
"text": "Texte de démonstration",
"html": "<p>Texte de démonstration</p>",
"locale": "fr-FR"
}
]
}
],
"startSendingTime": "2019-08-24T14:15:22Z"
}

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"filter": "firstName:John;lastName:Doe",
"title": "string",
"messages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"weight": 75,
"templates": [{"from": "example@example.com",
"subject": "Sujet de démonstration",
"text": "Texte de démonstration",
"html": "<p>Texte de démonstration</p>",
"locale": "fr-FR"
}
]
}
],
"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": [{"href": "string",
"rel": "self"
}
]
}

➔ Next to Cashier