Skip to navigation

Unassign study group treatments

Beta

Unassigns between 1 and 100 of the study’s treatments from the study group and returns no content. A treatment the group does not hold is left as it is and no treatment is assigned, so the same request may be sent again without failing. The treatments themselves are not deleted and stay available to other groups. The request is validated as a whole; if any item is invalid, none are unassigned. 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 unassign from the study group.
treatment_idslist of stringsRequired
Between 1 and 100 treatments on the study, each listed at most once.

Response

The treatments were unassigned.

Errors

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