Skip to main content
PUT
/
api
/
v1
/
studies
/
{id}
Update Study
curl --request PUT \
  --url https://api.getversive.com/api/v1/studies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "primaryColor": "#FF0000"
  }
}
'
{
  "id": "study_123",
  "title": "My Study",
  "metadata": {},
  "type": "VERSIVE_STUDY",
  "mode": "TEXT_AND_VOICE",
  "created_at": "2024-01-01T00:00:00Z",
  "description": "A study about preferences.",
  "config": {
    "interviewName": "Interviewer",
    "primaryColor": "#0E9489"
  },
  "welcome_message": {
    "title": "Welcome",
    "body": "Thanks for participating."
  },
  "thank_you_message": {
    "title": "Thank You",
    "body": "Goodbye."
  },
  "screen_out_message": {
    "title": "Screened Out",
    "body": "Sorry."
  }
}
Update the configuration or metadata of an existing study. Only provided fields will be updated.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
config
Config · object

Response

Successful Response