POST /broadcast-messages

Creates a broadcast message.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the broadcast message.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`messages[]`	Array	Yes	List of messages.
`messages[].id`	String	No	ID of the message.
`messages[].templates[]`	Array	Yes	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.
`messages[].templates[].html`	String	Yes	HTML body of the message. To use content from the `text` field, leave this field empty. The use of template placeholders is permitted for this field.
`messages[].templates[].text`	String	Yes	Text body of the message. To use content from the `html` field, leave this field empty. The use of template placeholders is permitted for this field.
`messages[].templates[].locale`	String	Yes	Language locale identifier in RFC 5646 format.
`messages[].templates[].subject`	String	Yes	Subject of the message. The use of template placeholders is permitted for this field.
`messages[].templates[].from`	String	Yes	Email address of the sender. Important: This value must be a verified email address. To verify an email address: Create an email delivery setting. In the response, you receive the email and a token. Verify the email delivery by passing the token as the path parameter.
`messages[].version`	String	No	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.
`messages[].weight`	Integer	No	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. Default value: 100
`updatedTime`	String	No	Date and time when the resource is updated. This value is set automatically when the resource is updated.
`filter`	String	No	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.
`createdTime`	String	No	Date and time when the resource is created. This value is set automatically when the resource is created.
`splitTestStartTime`	String	No	Date and time when the split test messages are scheduled to send.
`title`	String	No	Title of the message. This title displays in reports.
`status`	String	No	Status of the broadcast message. Valid values: `"sending"` `"sent"` `"archived"` `"draft"`
`startSendingTime`	String	Yes	Date and time when the message is scheduled to send.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.