Skip to navigation

Delete study groups

Beta

Deletes between 1 and 100 treatment groups from the study. Animals assigned to a deleted group stay on the study and lose their group, and a deleted group stops being the control group of the study. The remaining groups keep their order and are renumbered from 1, so their no may change. The request is validated as a whole; if any item is invalid, none are deleted. 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.

Headers

X-Studies-Api-VersionstringOptional

Request

The study groups to delete.
study_groupslist of stringsRequired
Between 1 and 100 study groups on the study, each listed at most once.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The study groups were deleted.
deletedboolean

Always true. A failed deletion is reported as a 4xx error instead.

Errors

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