Skip to navigation
APIsStudy ResourcesStudy Observations

Delete observations

Deletes up to 100 observations from the study. The request is validated as a whole; if any observation 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 observations to delete.
observationslist of stringsRequired
Up to 100 observations on the study, each listed at most once. An empty list is accepted and deletes nothing.

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 observations 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