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/urlSandbox URL
PUT https://api.storekit-sandbox.apple.com/inApps/v1/messaging/realtime/urlResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK | Request succeeded. | |
| 400 | Bad Request Content-Type: application/json | BadRequestRealtimeUrlError | 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 Content-Type: application/json | ForbiddenNoPassingTestError | 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 | Content-Type: application/json | RateLimitExceededError | The request exceeded the rate limit. For more information, see Identifying rate limits. |
| 500 | Internal Server Error Content-Type: application/json | GeneralInternalError | Server error. Try again later. |
Mentioned in
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.
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 Messageendpoint 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.