Skip to navigation
APIsStudy ResourcesStudy Dosages

Delete dosages

Deletes between 1 and 100 dosages from the study. The request is validated as a whole; if any dosage cannot be deleted, none are.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

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

Headers

X-Studies-Api-VersionstringOptional

Request

The dosages to delete.
dosageslist of stringsRequired
Between 1 and 100 dosages 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 dosages 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