Update a study

Authorizations

Authorization

string

header

required

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

Path Parameters

studyId

string

required

Body

application/json

studyPlan

object

required

studyPlan.brandingConfigId

string | null

required

The ID of the branding configuration

studyPlan.consentFormId

string | null

required

The ID of the consent form

studyPlan.description

string | null

required

The internal description of the study

studyPlan.endDate

string | null

required

The end date of the study in ISO 8601 in UTC(with no offset)

studyPlan.externalDescription

string | null

required

The external description of the study

studyPlan.externalName

string | null

required

The external name of the study

studyPlan.incentive

object | null

required

The incentive details for the study

studyPlan.incentive.amount

number | null

required

The amount of the incentive

studyPlan.incentive.incentiveBudgetId

string | null

required

The ID of the incentive budget

studyPlan.incentive.incentiveType

enum<string>

required

The type of incentive

Available options:

MONEY_OR_GIFT_CARD,

MONEY_OR_GIFT_CARD_WITH_TREMENDOUS,

EXTERNAL_MONEY_OR_GIFT_CARD,

CHARITY,

CUSTOM,

RESPONDENT_MONEY,

RECRUITMENT_FEE

studyPlan.includeScreener

boolean

required

Whether to include a screener. If type is SURVEY the default is true, if not then false

studyPlan.language

enum<string>

default:

required

The language code for the study

Available options:

en,

es,

fr,

it,

ro,

pt,

pl,

de,

nl,

ja

studyPlan.name

string | null

required

The internal name of the study

studyPlan.participationLimit

number | null

default:

required

The participation limit of the study

studyPlan.researchPlanUrl

string | null

required

The URL of the research plan

studyPlan.startDate

string | null

required

The start date of the study in ISO 8601 in UTC(with no offset)

Response

200 - application/json

Study object

recruitmentStrategy

enum<string>

required

The recruitment strategy for the study

Available options:

IN_RALLY,

EXTERNAL

status

enum<string>

required

The status of the study

Available options:

DRAFT,

ACTIVE,

PAUSED,

CLOSED

studyId

string

required

studyPlan

object

required

studyPlan.brandingConfigId

string | null

required

The ID of the branding configuration

studyPlan.consentFormId

string | null

required

The ID of the consent form

studyPlan.description

string | null

required

The internal description of the study

studyPlan.endDate

string | null

required

The end date of the study in ISO 8601 in UTC(with no offset)

studyPlan.externalDescription

string | null

required

The external description of the study

studyPlan.externalName

string | null

required

The external name of the study

studyPlan.incentive

object | null

required

The incentive details for the study

studyPlan.incentive.amount

number | null

required

The amount of the incentive

studyPlan.incentive.incentiveBudgetId

string | null

required

The ID of the incentive budget

studyPlan.incentive.incentiveType

enum<string>

required

The type of incentive

Available options:

MONEY_OR_GIFT_CARD,

MONEY_OR_GIFT_CARD_WITH_TREMENDOUS,

EXTERNAL_MONEY_OR_GIFT_CARD,

CHARITY,

CUSTOM,

RESPONDENT_MONEY,

RECRUITMENT_FEE

studyPlan.includeScreener

boolean

required

Whether to include a screener. If type is SURVEY the default is true, if not then false

studyPlan.language

enum<string>

default:

required

The language code for the study

Available options:

en,

es,

fr,

it,

ro,

pt,

pl,

de,

nl,

ja

studyPlan.name

string | null

required

The internal name of the study

studyPlan.participationLimit

number | null

default:

required

The participation limit of the study

studyPlan.researchPlanUrl

string | null

required

The URL of the research plan

studyPlan.startDate

string | null

required

The start date of the study in ISO 8601 in UTC(with no offset)

studyType

enum<string>

required

The type of study

Available options:

SURVEY,

INTERVIEWS,

UNMODERATED_TEST,

GROUP_INTERVIEW

Backfills

Person

Imports

Incentives

Panels

People

Populations

Person Properties

Segments

Studies

Participants

Teams

Users

Authorizations

Path Parameters

Body

Response