Skip to navigation
APIsStudy ResourcesStudy Observations

Update observations

Updates between 1 and 100 observations on the study. The request is validated as a whole; if any item is invalid, none are updated.

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 changes to apply to each observation.
idstringRequiredformat: "^obs_[a-zA-Z0-9]{10,22}$"
The observation to update. Must be on the study.
observed_atstringOptional>=1 character

When the observation was made, as a full ISO-8601 UTC date-time: either an explicit UTC instant (offset Z or +00:00) or an offset-less date-time taken as UTC. Date-only values and non-UTC offsets are rejected. May not be before the animal’s date of birth.

valuestringOptional>=1 character

The new reading, validated against the observation’s existing type. Rejected for observations of type none.

textstring or nullOptional<=5000 characters

A free-form note to record with the observation.

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 updated observations.
datalist of objects
The observations.

Errors

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