Skip to main content
POST
Regenerate Study External Panel Token

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key
string | null
X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

study_id
string
required

Response

Successful Response

complete_redirect_url
string
required
screenout_redirect_url
string
required
id
string
required
study_id
string
required
entry_url
string
required
provider
enum<string>
default:custom
Available options:
prolific,
cint,
cloudresearch,
terac,
custom
respondent_id_param
string
default:respondent_id
respondent_id_placeholder
string
default:{{RESPONDENT_ID}}
session_id_param
string | null
session_id_placeholder
string | null
external_study_id_param
string | null
external_study_id_placeholder
string | null
quota_full_redirect_url
string | null
technical_redirect_url
string | null