Sign in
Studies

Update a scenario

Change a study's identity or its exposure — but not both in one call. Send mode on its own. Identity and exposure are separate operations upstream, and applying them in sequence could leave the study live in a mode you did not ask for.

Narrowing mode bumps accessVersion upstream and invalidates sessions minted under the old one.

patch/projects/{projectId}/studies/{studyId}

Request body

namestring
descriptionstring
mode'project_members' | 'invited_only' | 'anyone_with_link'

Who may open the share link:

  • project_members — signed-in members of the project only
  • invited_only — named members, invited individually
  • anyone_with_link — anyone holding the URL, signed in or not

Response

The updated study.

idstring required
projectIdstring required
namestring nullable required
descriptionstring nullable required
mode'project_members' | 'invited_only' | 'anyone_with_link' | 'null' nullable required

Changes

Changed in 1 of the 122 revisions of this API.1