Delete Realtime URL
Deletes the URL for your Get Retention Message endpoint, in the sandbox or production environments.
URL
DELETE https://api.storekit.apple.com/inApps/v1/messaging/realtime/urlSandbox URL
DELETE https://api.storekit-sandbox.apple.com/inApps/v1/messaging/realtime/urlResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK | Request succeeded. | |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 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’s sandbox URL to delete the sandbox URL of your Get Retention Message endpoint. Call this endpoint’s production URL to delete the production URL of your Get Retention Message endpoint.
After this call succeeds in the sandbox or production environment, the Retention Messaging API no longer provides real-time retention messages in the respective environment, unless you configure a URL again.
To configure URLs again, call Configure Realtime URL. There’s no need to call Delete Realtime URL before reconfiguring endpoint URLs. To check the URL you have configured for your endpoint, call Get Realtime URL.