Skip to navigation
APIsAnimal ResourcesAnimals

Delete an animal

Deletes an animal along with everything recorded against it. This cannot be undone. Responds 200 with a confirmation body rather than 204.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

animalIdstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"
The unique identifier of the animal.

Headers

X-Studies-Api-VersionstringOptional

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 animal was 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
404
Not Found Error
429
Too Many Requests Error