Skip to navigation

Assign study group treatments

Beta

Assigns between 1 and 100 of the study’s treatments to the study group. Only treatments classified as treatment can be assigned; pre-treatments and disease inductions cannot. A treatment the group already holds is left as it is and no treatment is unassigned, so the same request may be sent again without assigning anything twice. The request is validated as a whole; if any item is invalid, none are assigned. The study may not be archived or canceled.

Authentication

AuthorizationBearer

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

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
studyGroupIdstringRequiredformat: "^grp_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study group.

Headers

X-Studies-Api-VersionstringOptional

Request

The treatments to assign to the study group.
treatment_idslist of stringsRequired

Between 1 and 100 treatments on the study, each listed at most once. Only treatments classified as treatment can be assigned; a pre-treatment or disease induction is rejected.

Response

The treatments were assigned.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error