Redirect an end user
Method GET {API_BASE}/v2.1/user/{key}/{crid}/redirect
Redirect to the recording or preview page according to current code status.
Authorization
Required scope
user_v2
The API key is intentionally kept in the path for V2 compatibility:
/v2.1/client/{key}/{crid}/... or /v2.1/user/{key}/{crid}/....
Client routes require the client_v2 scope. User routes require the user_v2
scope. Unknown, expired, revoked, malformed, or wrong-scope keys return the
legacy JSON error envelope.
Parameters
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
key |
Path | string |
Required |
API key kept in the URL for V2 compatibility. Requires client_v2 or user_v2 depending on the route.
|
|
crid |
Path | string |
Required | Client reference ID, usually an order or campaign reference. |
Responses
Redirect to the resolved user-facing destination.
Invalid key, CRID, payload, message state or business precondition.
Key is authenticated but scope or platform constraints are invalid.
{
"status": 1,
"error": "forbidden"
}
forbidden
{
"status": 1,
"error": "forbidden"
}
invalidPlatformConstraint
{
"status": 1,
"error": "key_invalid"
}