UploadMessageRequestBody
The request body for uploading a message, which includes the message text and an optional image reference and bullet points.
Declaration
object UploadMessageRequestBodyProperties
| Name | Type | Description |
|---|---|---|
header Required | header | The header text of the retention message that the system displays to customers. |
body Required | body | The body text of the retention message that the system displays to customers. |
image | UploadMessageImage | The optional image identifier and its alternative text to appear as part of a text-based message with an image. |
bulletPoints | [BulletPoint] | An optional array of bullet points. |
headerPosition | headerPosition | The position of header text, which defaults to placing header text above the body. |
Mentioned in
Discussion
This is the request body for the Upload Message endpoint.
All messages require body and header text.
Don’t include an image or bulletPoints when you upload the text for the following retention message types:
A promotional-offer retention message
A switch-plan retention message
All default retention messages require body text and header text, and may optionally include an image and bullet points. To place header text above an image, include an image, and set the value of headerPosition to ABOVE_IMAGE. Otherwise, the header text appears above the message body, which is below the image.