Update a study
Update a study in your workspace. All data returned from a GET on a study needs to be included or will be overwritten. Certain features not supported and require updating in the UI
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in ISO 8601 in UTC(with no offset)
The end date of the study in ISO 8601 in UTC(with no offset)
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
The ID of the incentive budget
The amount of the incentive
Whether to include a screener. If type is SURVEY
the default is true, if not then false
The ID of the branding configuration
The language code for the study
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in ISO 8601 in UTC(with no offset)
The end date of the study in ISO 8601 in UTC(with no offset)
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
MONEY_OR_GIFT_CARD
, MONEY_OR_GIFT_CARD_WITH_TREMENDOUS
, EXTERNAL_MONEY_OR_GIFT_CARD
, CHARITY
, CUSTOM
, RESPONDENT_MONEY
, RECRUITMENT_FEE
The ID of the incentive budget
The amount of the incentive
Whether to include a screener. If type is SURVEY
the default is true, if not then false
The ID of the branding configuration
The language code for the study
en
, es
, fr
, it
, ro
, pt
, pl
, de
, nl
, ja
Response
Study object
The type of study
SURVEY
, INTERVIEWS
, UNMODERATED_TEST
, GROUP_INTERVIEW
The recruitment strategy for the study
IN_RALLY
, EXTERNAL
The status of the study
DRAFT
, ACTIVE
, PAUSED
, CLOSED
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in ISO 8601 in UTC(with no offset)
The end date of the study in ISO 8601 in UTC(with no offset)
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
MONEY_OR_GIFT_CARD
, MONEY_OR_GIFT_CARD_WITH_TREMENDOUS
, EXTERNAL_MONEY_OR_GIFT_CARD
, CHARITY
, CUSTOM
, RESPONDENT_MONEY
, RECRUITMENT_FEE
The ID of the incentive budget
The amount of the incentive
Whether to include a screener. If type is SURVEY
the default is true, if not then false
The ID of the branding configuration
The language code for the study
en
, es
, fr
, it
, ro
, pt
, pl
, de
, nl
, ja