Rally Developer Docs home page

Support

Studies

Update a study status

Backfills

POST
Import activities

Person

GET
Returns a person in your workspace
POST
Updates a person's opted out status
POST
Deletes people by email

Imports

GET
Gets an import by id

Incentives

POST
Get paginated list of incentives

Panels

POST
Get paginated list of panels

People

POST
Search for people
POST
Import people
POST
Delete people
DEL
Delete a person
GET
Get a person's opted out status by ID or email
PUT
Update a person's opted out status

Populations

GET
Paginated list of population in your workspace

Person Properties

POST
Create multiple new person properties
GET
Get all person properties in your workspace
POST
Delete person properties in bulk
GET
Get a person property by ID
PUT
Update a person property by ID
DEL
Deletes a person property by ID

Segments

POST
Paginated list of segments in your workspace

Studies

POST
Create a new study
POST
Get paginated list of studies in your workspace.
GET
Get a study by ID
PUT
Update a study
POST
Update a study status

Participants

POST
Paginated list of participants in a study
POST
Import participants to a study

Teams

GET
Paginated list of teams in your workspace

Users

GET
Gets a paginated list of all users

Studies

Update a study status

Update the status of a study in your workspace. This is the only way to programatically change a study’s status

POST

studies

{studyId}

status

Authorization

string

Bearer

Authorization

Required

string

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

studyId

string

studyId

Required

string

object

status

enum<string>

status

Required

enum<string>

Statuses a study can be updated to via the API

Authorizations

Authorization

string

headerrequired

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

Path Parameters

studyId

string

required

Body

application/json

status

enum<string>

required

Statuses a study can be updated to via the API

Available options:

PAUSED,

CLOSED

Response

200 - application/json

Study object

studyId

string

required

studyType

enum<string>

required

The type of study

Available options:

SURVEY,

INTERVIEWS,

UNMODERATED_TEST,

GROUP_INTERVIEW

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

studyPlan

object

required

studyPlan.name

string | null

required

The internal name of the study

studyPlan.externalName

string | null

required

The external name of the study

studyPlan.description

string | null

required

The internal description of the study

studyPlan.externalDescription

string | null

required

The external description of the study

studyPlan.startDate

string | null

required

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

studyPlan.endDate

string | null

required

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

studyPlan.researchPlanUrl

string | null

required

The URL of the research plan

studyPlan.participationLimit

number | null

default: 10required

The participation limit of the study

studyPlan.consentFormId

string | null

required

The ID of the consent form

studyPlan.incentive

object | null

required

The incentive details for the study

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.incentive.incentiveBudgetId

string | null

required

The ID of the incentive budget

studyPlan.incentive.amount

number | null

required

The amount of the incentive

studyPlan.includeScreener

boolean

required

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

studyPlan.brandingConfigId

string | null

required

The ID of the branding configuration

studyPlan.language

enum<string>

default: enrequired

The language code for the study

Available options:

en,

es,

fr,

it,

ro,

pt,

pl,

de,

nl,

ja

Update a study Paginated list of participants in a study

x linkedin