Terminate animals

POST

https://acme-api.invivo.benchling.com/api/public/v1/studies/:studyId/animals/terminate

POST

/api/public/v1/studies/:studyId/animals/terminate

curl -X POST https://acme-api.invivo.benchling.com/api/public/v1/studies/sdy_3vQ8kZpLmN2xRt7YwBcDfG/animals/terminate \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "animal_ids": [
    "aml_71H39zdfOc89pNIutQSI22"
  ],
  "termination_reason": "tgy_I2L48jzuxGuA4sQgjfLIS",
  "terminated_at": "2026-09-10",
  "disease_survivor": false,
  "comment": "End of study."
}'

{
  "data": [
    {
      "id": "aml_7KpQ2mNvR4tXwZ9bYcDfGh",
      "name": "string",
      "number": 1,
      "catalog": "string",
      "species": "Mus musculus",
      "strain": "string",
      "sex": "m",
      "dob": "2026-09-18",
      "donor": "string",
      "ear": "string",
      "tag": "string",
      "tail": "string",
      "study": {
        "id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
        "project_id": "pjt_9kLmNpQrStUvWxYzAbCdEf",
        "name": "string",
        "code": "string",
        "study_code_id": "sdc_7hJ4nQrXsT9wYzAbCdEfGh",
        "type": "internal",
        "status": "in_progress",
        "description": "string",
        "timezone": "America/Los_Angeles",
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "author": {
          "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
          "name": "string",
          "email": "string",
          "timezone": "string"
        },
        "owner": {
          "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
          "name": "string",
          "email": "string",
          "timezone": "string"
        },
        "started_on": "2026-09-18",
        "tracking_day_base": 1,
        "completed_at": "2026-09-18T14:03:22.123456Z",
        "canceled_at": "2026-09-18T14:03:22.123456Z",
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "study_group": {
        "id": "grp_9nT4kZpMvR2xQw8YbCdFgJ",
        "study_id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
        "name": "string",
        "no": 1,
        "color": "string",
        "max_animals": 1,
        "control": true,
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "cage": {
        "id": "cge_5mR8kWpQnL3xTv7YzBcDfH",
        "study_id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
        "name": "string",
        "catalog": "string",
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "tracking_date": "2026-09-18",
      "disease_induction_date": "2026-09-18",
      "disease_survivor": true,
      "terminated_at": "2026-09-18",
      "terminated_by": {
        "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
        "name": "string",
        "email": "string",
        "timezone": "string"
      },
      "terminated_reason": {
        "glossary_id": "gly_5xQ4mKpNvR9zTw3YbCdFgV",
        "title": "string",
        "comment": "string"
      },
      "metadata": {
        "cohort_size": 24,
        "species": "Mus musculus"
      },
      "created_at": "2026-09-18T14:03:22.123456Z",
      "updated_at": "2026-09-18T14:03:22.123456Z"
    }
  ]
}

Terminates between 1 and 100 animals on the study. The request is validated as a whole; if any animal cannot be terminated, 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.

Request

The animals to terminate.

animal_idslist of stringsRequired

Between 1 and 100 animals on the study to terminate, none already terminated. Duplicates are ignored.

termination_reasonstringRequiredformat: "^tgy_[a-zA-Z0-9]{10,22}$"

The reason for termination, an entry in your team's euthanasia reasons glossary.

terminated_atdate or nullOptional

The day the animals were terminated, recorded at midday. Defaults to the current date on the server.

disease_survivorbooleanOptional

Whether the animals survived the induced disease. Defaults to false.

commentstring or nullOptional<=5000 characters

A comment recorded against the termination.

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 terminated animals.

datalist of objects

The animals.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error