> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rescueconsole.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Change many animals

> One change to as many as 200 animals at once, named by `ids` or chosen by `filter`: send exactly one of the two. `filter` is a query string in the list's own terms, such as `status=intake_processing&species=cat`, and selects what the list would show. A selection of more than 200 is refused before anything changes. `set_status`, `add_tag` and `remove_tag` take `value`. `update` takes `patch`, which may set only the fields listed below. `delete` deletes each animal, as deleting one does. An animal that already holds every value is left alone and counted as unchanged. A status change closes an active foster placement exactly as changing one animal does. Status changes, updates and deletes are recorded in each animal's activity and sent to your webhooks; tags are not. Needs **write** on Animals.



## OpenAPI

````yaml /api-reference/openapi.json post /api/animals/animals/bulk
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-09-19'
  description: >-
    Your own organization's records, from your own software. There is no
    sandbox: every request goes to your live organization.
servers:
  - url: https://{organization}.rescueconsole.com
    description: Your own organization's address, the one you sign in at.
    variables:
      organization:
        default: your-rescue
        description: >-
          The first part of the address you sign in at. A key only works at the
          address of the organization it was made in.
security:
  - apiKey: []
tags:
  - name: Animals
    description: The animals in your care, and the ones you have placed.
  - name: Animal notes
    description: Notes written on an animal's record.
  - name: Animal weights
    description: An animal's weight readings, one per weighing.
  - name: Animal medical records
    description: >-
      Vaccines, treatments, procedures, tests, exams and other medical records
      on one animal.
  - name: Animal placements
    description: The people an animal came from or has been placed with, over time.
  - name: Animal nutrition
    description: 'What an animal eats: its feeding list and its diet.'
  - name: Animal relationships
    description: Siblings, parents, offspring and bonded pairs.
  - name: Animal tags
    description: Your own short labels on an animal.
  - name: Breeds
    description: The breed or kind lists your intake form offers for each species.
  - name: Litters
    description: Litters, and the animals born into them.
  - name: Locations and housing
    description: >-
      The places animals are housed at each of your locations: campuses,
      buildings, rooms and cages, the tunnels that join cages into one space,
      and who is in each.
  - name: Foster homes
    description: >-
      The people who foster for you, what each home can take, and the animals
      offered to and placed with them.
  - name: Intakes
    description: >-
      How each animal arrived: the route in, who brought it, why it was given up
      and the state it came in.
  - name: Medical due
    description: >-
      Medical work that is outstanding across all your animals, and one medical
      record added to many animals at once.
  - name: Transports
    description: >-
      Transport runs: a chain of drives, each leg with its own driver, that
      moves animals from one place to another.
  - name: Animal calendar
    description: >-
      The dated things in animal care on one calendar: medical work due,
      adoptions, foster placements starting and ending, arrivals, and meet and
      greets.
  - name: Animal reports
    description: >-
      The operations report: intakes, outcomes, live release rate and the
      animals in your care, each figure with its own definition.
  - name: Adoption applications
    description: >-
      Applications to adopt or foster, from first draft to a decision, and the
      adoption contract signed on an approved one.
  - name: Adoptions
    description: >-
      Animals that went home, what each adopter owes and has paid, and closing
      or reversing the adoption.
  - name: Signed contracts
    description: >-
      Contracts signed on an adoption, a foster placement or an intake, each
      kept exactly as it read when it was signed.
  - name: Contract templates
    description: >-
      The contracts your organization has people sign, with the merge fields
      that fill them in.
  - name: Reconciliations
    description: >-
      A payment processor's settlement lines, matched against the adoption
      payments you recorded.
  - name: Animal custom fields
    description: >-
      The extra fields your organization adds to animals, housing units and
      adoption applications.
  - name: Age groups
    description: >-
      What counts as a baby, an adult or a senior, per species, which fee rules
      and discounts read.
  - name: Animal statuses
    description: >-
      Your organization's status vocabulary for animal records, and what kind of
      status each one is.
  - name: Application stages
    description: >-
      The steps an adoption or foster application moves through before it is
      decided, in your organization's words.
  - name: Behaviour attributes
    description: >-
      The catalogue of behavioural traits, and where a trait with each name may
      be shown beyond the record.
  - name: Cage card templates
    description: >-
      The layouts your organization prints for the kennel door: paper, fields,
      photo and QR code.
  - name: Adoption fee schedules
    description: >-
      The rules that suggest an animal's adoption fee, and the discounts laid
      over them.
  - name: Medical catalogue
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: People
    description: >-
      The people your organization deals with: adopters, donors, volunteers,
      fosters and everybody else.
  - name: Person notes
    description: Notes written on a person's record.
  - name: Person contacts
    description: >-
      A person's phone numbers and email addresses, one of each kind marked
      primary.
  - name: Person addresses
    description: A person's addresses, one of them primary.
  - name: Person tags
    description: Free-text labels on a person, added and removed one at a time.
  - name: People duplicates
    description: People who look like the same person entered twice, and merging them.
  - name: People custom fields
    description: The fields a person's record carries beyond the standard ones.
  - name: Organizations
    description: >-
      The outside organizations your rescue deals with: veterinary practices,
      partner rescues, shelters, suppliers, employers and agencies.
  - name: Organization locations
    description: An organization's places, one of them the main one.
  - name: Affiliations
    description: >-
      Who works at, volunteers for or otherwise belongs to an organization, now
      or in the past.
  - name: Forms
    description: >-
      The forms your organization publishes, such as an adoption application or
      a volunteer sign-up, and the questions on them.
  - name: Submissions
    description: >-
      What people sent through your forms, and what your team does with each
      one.
  - name: Tasks
    description: >-
      To-dos, on a record or for the whole organization, narrowed to the records
      your key may read.
  - name: Calendar
    description: >-
      The dated work across your organization in one list, narrowed to the areas
      your key may read.
  - name: Activity
    description: >-
      What was created, changed and deleted in your organization, narrowed to
      the areas your key may read.
  - name: Shift schedules
    description: >-
      Schedules: the occasions shifts are grouped under, such as an adoption day
      or Saturday kennel cover.
  - name: Shift windows
    description: >-
      Shifts: a stretch of time at a place, with the volunteer roles it needs
      and how many of each (the address calls a shift a window).
  - name: Shift bookings
    description: >-
      Sign-ups: a person taking a role on a shift, giving it up, and the hours
      they worked.
  - name: Volunteers
    description: >-
      The people who volunteer: where each stands, what they have done, and
      where they would rather work.
  - name: Volunteer roles
    description: >-
      The jobs a volunteer can sign up for, such as Dog walker or Adoption
      counselor.
  - name: Volunteer qualifications
    description: 'Approvals: who may take which role, and at which location.'
  - name: Shift policies
    description: The rules you set for sign-ups and cancellations.
  - name: Shift calendar
    description: Schedules and shifts as calendar items for a date range.
  - name: Shift custom fields
    description: Your own fields on schedules, shifts and sign-ups.
  - name: Events
    description: >-
      The occasions your rescue hosts: adoption days, fundraisers, clinics and
      the rest.
  - name: Events calendar
    description: Your events between two days, as calendar entries.
  - name: Campaigns
    description: >-
      Appeals you raise money for, each with its goal and what it has raised so
      far.
  - name: Donations
    description: 'Gifts of money: how much, from whom, and what they were given to.'
  - name: Donors
    description: The people who have given, with what each has given in all.
  - name: Wish list
    description: The things your rescue needs, and the deliveries that met them.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Message templates
    description: >-
      Saved wording your organization sends again and again, with merge fields
      filled from your records.
  - name: Sending
    description: >-
      Everything here sends real email from your organization, and none of it
      can be unsent.
  - name: Message log
    description: >-
      The email your organization has sent or tried to send, and what became of
      each message.
  - name: Conversations
    description: >-
      The email conversations in your organization's inboxes, and the records
      each one is about.
  - name: Inboxes
    description: >-
      The addresses your organization receives email at, and who may read each
      one.
  - name: Contact preferences
    description: >-
      Whether a person has asked not to be emailed, altogether or about one kind
      of message.
  - name: Suppressions
    description: >-
      Addresses no email goes to, because mail to them bounced or their owner
      asked not to be written to.
  - name: Sender and deliverability
    description: Who your organization's email goes out as, and how much of it arrives.
  - name: Registry flags
    description: >-
      Safety flags your organization files about a person or an animal, which
      other organizations using RescueConsole can see once the flag is vetted
      and shared.
  - name: Registry reviews
    description: >-
      Another organization's vote on a flag it did not file, which decides
      whether the flag becomes active or disputed.
  - name: Registry search
    description: >-
      The lookup by microchip number that anybody may make, with or without a
      key.
paths:
  /api/animals/animals/bulk:
    post:
      tags:
        - Animals
      summary: Change many animals
      description: >-
        One change to as many as 200 animals at once, named by `ids` or chosen
        by `filter`: send exactly one of the two. `filter` is a query string in
        the list's own terms, such as `status=intake_processing&species=cat`,
        and selects what the list would show. A selection of more than 200 is
        refused before anything changes. `set_status`, `add_tag` and
        `remove_tag` take `value`. `update` takes `patch`, which may set only
        the fields listed below. `delete` deletes each animal, as deleting one
        does. An animal that already holds every value is left alone and counted
        as unchanged. A status change closes an active foster placement exactly
        as changing one animal does. Status changes, updates and deletes are
        recorded in each animal's activity and sent to your webhooks; tags are
        not. Needs **write** on Animals.
      operationId: bulkUpdateAnimals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnimalBulkChange'
            examples:
              setStatus:
                summary: Set a status on chosen animals
                value:
                  action: set_status
                  value: available_for_adoption
                  ids:
                    - b3e9a7c4-1f26-4d58-8e0b-5a4c2d7f9e63
                    - 0a8c5e21-7b3d-4f96-b1e4-92d6c3a8f507
                    - e71b4d09-3a6f-4c2e-9d85-6f0a1b2c3e48
              updateByFilter:
                summary: Change fields on every animal a filter finds
                value:
                  action: update
                  filter: status=intake_processing&species=cat&tag=Spice%20litter
                  patch:
                    altered: 'yes'
                    is_public: true
      responses:
        '200':
          description: What was done.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnimalBulkResult'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    AnimalBulkChange:
      type: object
      required:
        - action
      properties:
        action:
          type: string
          enum:
            - set_status
            - add_tag
            - remove_tag
            - update
            - delete
        value:
          type: string
          description: For set_status, the status key; for add_tag and remove_tag, the tag.
        patch:
          type: object
          additionalProperties: false
          description: >-
            For update: the fields to set on every animal. Any other field is
            refused.
          properties:
            status:
              type: string
              description: One of your own status keys.
            species:
              type: string
              description: A species key, or a common word for one.
            sex:
              type: string
              enum:
                - male
                - female
                - unknown
            altered:
              type:
                - string
                - 'null'
              enum:
                - 'yes'
                - 'no'
                - unknown
                - null
            health_status:
              type:
                - string
                - 'null'
              description: >-
                One of: healthy, minor_issue, under_treatment, recovering,
                chronic_condition, special_needs, critical, hospice.
            is_public:
              type: boolean
            current_location_unit_id:
              type:
                - string
                - 'null'
              description: A location or unit ID. Null clears it.
            adoption_fee_cents:
              type:
                - integer
                - 'null'
              description: In cents. Null is no fee set.
              minimum: 0
            breed:
              type:
                - string
                - 'null'
            size:
              type:
                - string
                - 'null'
              enum:
                - small
                - medium
                - large
                - extra_large
                - null
            intake_source:
              type:
                - string
                - 'null'
              enum:
                - stray
                - transfer
                - owner_surrender
                - field
                - born_in_care
                - adoption_return
                - seized
                - other
                - null
        ids:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 200
          description: >-
            The animals' record IDs. Every one must be yours, or nothing changes
            and the answer is 404.
        filter:
          type: string
          description: >-
            A query string of list filters. Refused when nothing matches or more
            than 200 match.
    AnimalBulkResult:
      type: object
      properties:
        updated:
          type: integer
          description: How many animals changed.
        unchanged:
          type: integer
          description: 'For set_status and update: how many already held every value.'
        action:
          type: string
          enum:
            - set_status
            - add_tag
            - remove_tag
            - update
            - delete
        value:
          type: string
          description: The value sent, or empty.
  responses:
    Problem:
      description: What is wrong, in one sentence you can show to a person.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
          example:
            error: house_trained must be 1, 0 or null (not assessed)
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys. It starts with rc_live_.

````