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

# RealtimeResponseBody

A response you provide to choose, in real time, a retention message the system displays to the customer.

```
object RealtimeResponseBody
```

## Discussion

Return this response when the App Store calls your `Get Retention Message` endpoint.

In this response, you select a retention message in real time for the system to display to your customer. Choose a message based on your business needs and by considering the information you receive in [`RealtimeRequestBody`](/documentation/RetentionMessaging/RealtimeRequestBody).

All messages and images need to be in an `APPROVED` state for the system to display them to customers. For more information, see [Setting up retention messages](/documentation/RetentionMessaging/setting-up-retention-messages), and  [Responding to real-time retention messaging requests](/documentation/RetentionMessaging/responding-to-realtime-retention-messaging-requests).

For more information on the Advanced Commerce API, see <doc://com.apple.documentation/documentation/AdvancedCommerceAPI>.

---

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)