Undo animal termination

POST

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

POST

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

curl -X POST https://acme-api.invivo.benchling.com/api/public/v1/studies/sdy_3vQ8kZpLmN2xRt7YwBcDfG/animals/undo-terminate \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "animal_ids": [
    "aml_71H39zdfOc89pNIutQSI22"
  ],
  "cage_id": "cge_6uFo3TUYezxtFuImb9kk8K"
}'

{
  "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"
    }
  ]
}

Reverses the termination of between 1 and 100 animals on the study and moves them into a cage. The request is validated as a whole; if any animal cannot be restored, 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 restore.

animal_idslist of stringsRequired

Between 1 and 100 terminated animals on the study. Duplicates are ignored.

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

The cage to return the animals to. Must be on the study and have room for all of them.

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

datalist of objects

The animals.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error