<!--
{
  "availability" : [
    "Retention Messaging API: 1.4.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RetentionMessaging",
  "identifier" : "/documentation/RetentionMessaging/Configure-Realtime-URL",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Retention Messaging API"
    ],
    "preciseIdentifier" : "rest:retention_messaging:put:inApps-v1-messaging-realtime-url"
  },
  "title" : "Configure Realtime URL"
}
-->

# Configure Realtime URL

Configures the URL for your Get Retention Message endpoint in the sandbox and production environments.

## Discussion

Call this endpoint to configure the URLs for your `Get Retention Message` endpoints in the sandbox and production environments. For more information, including endpoint specifications and server requirements, see [Setting up your Get Retention Message endpoint](/documentation/RetentionMessaging/setting-up-retention-messaging-endpoint).

> Note:
> Your server needs to pass a performance test before you can configure your `Get Retention Message` endpoint for the production environment. For more information, see ``doc://com.apple.retentionmessaging/documentation/RetentionMessaging/Initiate-Performance-Test``.

As a best practice, use different URLs for the sandbox and production environments.

### Configure your URL for the sandbox environment

To configure your `Get Retention Message` endpoint for the sandbox environment, call [`Configure Realtime URL`](/documentation/RetentionMessaging/Configure-Realtime-URL) using its sandbox URL. Provide your endpoint’s sandbox URL.

### Configure your URL for the production environment

To configure your `Get Retention Message` endpoint for the production environment, first configure your `Get Retention Message` endpoint for the sandbox environment, then:

1. Call [`Initiate Performance Test`](/documentation/RetentionMessaging/Initiate-Performance-Test) to test your endpoint in the sandbox environment.
2. Call [`Get Performance Test Results`](/documentation/RetentionMessaging/Get-Performance-Test-Results) and ensure your server passes the performance test.
3. To configure your `Get Retention Message` endpoint for the production environment, call [`Configure Realtime URL`](/documentation/RetentionMessaging/Configure-Realtime-URL) using its production URL. Provide your endpoint’s production URL.

### Change your endpoint’s URL

To change your endpoint’s URL, just call [`Configure Realtime URL`](/documentation/RetentionMessaging/Configure-Realtime-URL) again. The Retention Messaging API uses your most recent successful configuration. To check the URL you set, call [`Get Realtime URL`](/documentation/RetentionMessaging/Get-Realtime-URL).

To delete—or deconfigure—your endpoint’s URL entirely, call [`Delete Realtime URL`](/documentation/RetentionMessaging/Delete-Realtime-URL).

---

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)