<!--
{
  "availability" : [
    "Retention Messaging API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RetentionMessaging",
  "identifier" : "/documentation/RetentionMessaging/UploadMessageRequestBody",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Retention Messaging API"
    ],
    "preciseIdentifier" : "data:retention_messaging:UploadMessageRequestBody"
  },
  "title" : "UploadMessageRequestBody"
}
-->

# UploadMessageRequestBody

The request body for uploading a message, which includes the message text and an optional image reference and bullet points.

```
object UploadMessageRequestBody
```

## Discussion

This is the request body for the [`Upload Message`](/documentation/RetentionMessaging/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`](/documentation/RetentionMessaging/UploadMessageRequestBody/headerPosition) to `ABOVE_IMAGE`. Otherwise, the header text appears above the message body, which is below the image.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)