--- title: Configure Realtime URL framework: retentionmessaging role: symbol role_heading: Web Service Endpoint path: retentionmessaging/configure-realtime-url --- # Configure Realtime URL Configures the URL for your Get Retention Message endpoint in the sandbox and production environments. ## URL PUT https://api.storekit.apple.com/inApps/v1/messaging/realtime/url ## Sandbox URL PUT https://api.storekit-sandbox.apple.com/inApps/v1/messaging/realtime/url ## Response Codes 200 OK: Request succeeded. 400 Bad Request: The request is invalid and unacceptable. 401 Unauthorized: The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. 403 Forbidden: Passing a performance test is required before setting a production URL. 404 Not Found: The request is invalid because the developer account doesn’t have access to this API. For more information, see Request access to the Retention Messaging API. 429 : The request exceeded the rate limit. For more information, see Identifying rate limits. 500 Internal Server Error: Server error. Try again later. ## Mentioned in Setting up your Get Retention Message endpoint Identifying rate limits Retention Messaging API changelog ## Discussion 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. 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 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 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: Call Initiate Performance Test to test your endpoint in the sandbox environment. Call Get Performance Test Results and ensure your server passes the performance test. To configure your Get Retention Message endpoint for the production environment, call 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 again. The Retention Messaging API uses your most recent successful configuration. To check the URL you set, call Get Realtime URL. To delete—or deconfigure—your endpoint’s URL entirely, call Delete Realtime URL. ## HTTP Body The request body that includes your endpoint’s URL. ## See Also ### Real-time retention messaging setup - [Setting up your Get Retention Message endpoint](retentionmessaging/setting-up-retention-messaging-endpoint.md) - [Get Realtime URL](retentionmessaging/get-realtime-url.md) - [Delete Realtime URL](retentionmessaging/delete-realtime-url.md) - [RealtimeUrlRequest](retentionmessaging/realtimeurlrequest.md) - [RealtimeRequestBody](retentionmessaging/realtimerequestbody.md) - [RealtimeUrlResponse](retentionmessaging/realtimeurlresponse.md)