Skip to main content
PATCH
Update a survey's onboarding stage

Authorizations

Authorization
string
header
required

Personal API key (prefix up_). Create one in the studio under Account → API keys.

Path Parameters

studioId
string
required
surveyId
string
required

Body

application/json
onboardingContent
object[] | null

Onboarding content shown before the identity step. Empty content skips straight to the Identities step.

Maximum array length: 20
onboardingIdentityProviders
enum<string>[] | null

The identities a respondent must hold before submitting, in canonical order. Pass null to reset to the default (email).

Minimum array length: 1
Available options:
email,
discord,
steam,
google

Response

200 - application/json

The updated survey

data
object
required