---
title: "Configure Sandbox Retention Realtime URL"
method: POST
path: "/v2/retention-onboarding/sandbox/realtime-url"
tags: ["Retention Messaging Onboarding V2"]
---

# Configure Sandbox Retention Realtime URL

`POST /v2/retention-onboarding/sandbox/realtime-url`

## Request body

- object
  - `application_id` string, required

## Response `200`

Success

- object
  - `object` 'retention_realtime_url_result', required
  - `application_id` string, required
  - `environment` 'sandbox' | 'production', required — Apple environment: 'sandbox' for testing, 'production' for live
  - `expected_realtime_url` string, required
  - `realtime_url` string, nullable, required
  - `matches_expected` boolean, required

## Other responses

- `400` — The request did not match the expected schema | The request was invalid or malformed
- `401` — No API key was provided in the request | The API key does not have a valid format | The API key is invalid or has been revoked | An error occurred while validating the API key | The session cookie is invalid or expired
- `403` — The API key does not have permission to perform this action
- `404` — The requested resource was not found
- `429` — Too many requests have been made in a short period
- `500` — An unexpected error occurred on the server
- `502` — The upstream retention provider request failed

## Changes

- **2026-09-09** `217c96dc9a29` — 25 breaking
  - the `code` response's property type changed from `string` to no type for status `403`
  - the `code` response's property type changed from `string` to no type for status `404`
  - the `code` response's property type changed from `string` to no type for status `429`
  - the `code` response's property type changed from `string` to no type for status `500`
  - …21 more
  - …this revision’s changelog is incomplete

[Change history](https://skmtc.dev/superwall/apis/superwall-api-v2/changes/v2/retention-onboarding/sandbox/realtime-url/post.md)

---

[API](https://skmtc.dev/superwall/apis/superwall-api-v2.md) · [All operations](https://skmtc.dev/superwall/apis/superwall-api-v2/llms.txt) · [OpenAPI document](https://skmtc.dev/superwall/apis/superwall-api-v2/revisions/bfb85c07a3d3?raw)