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

# message

A message identifier you provide in a real-time response to your Get Retention Message endpoint.

```
object message
```

## Discussion

In your [`RealtimeResponseBody`](/documentation/RetentionMessaging/RealtimeResponseBody) real-time response, you can choose from mutually exclusive options. Include `message` in your response to provide a text-based message (with or without an image) as the retention message the system displays to the customer.

The message identifier needs to refer to a message that has a [`messageState`](/documentation/RetentionMessaging/messageState) of `APPROVED`; otherwise, the retention message fails. If the message includes an image, the image also needs to have an [`imageState`](/documentation/RetentionMessaging/imageState) of `APPROVED`. For more information about setting up messages, see [Setting up retention messages](/documentation/RetentionMessaging/setting-up-retention-messages).

---

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)