> ## 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.

# Answer a surrender request

> Accepts, waitlists or declines a surrender request; other kinds are refused. `accepted` with `animal` (its species, and a name if the answers lack one) adds the animal with an owner-surrender intake naming the person, who is added to People first if needed; `accepted` with `return_adoption_id`, one of the adoptions listed under `surrender.returning`, reverses that adoption instead and records the animal's return, with the note as the reason. Either way the animal is linked to the submission. Accepting is final (409 afterwards) and needs **write** on Animals as well. It waits on the request's checklist: while an open workflow run the request started has a required step pending (other than one whose Done when is `submission.surrender_decided_at`, which any answer ticks), `accepted` is refused with 409 and `steps_first`, after the person is added to People and before anything is recorded. `outcome: null` undoes a waitlist or a decline. Not on spam. Needs **write** on the area of the form's kind.



## OpenAPI

````yaml /api-reference/openapi.json post /api/forms/submissions/{id}/surrender
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-11-04'
  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 temperatures
    description: >-
      An animal's temperatures, as typed, with its exams' own read in and the
      species' usual range.
  - name: Animal readiness
    description: >-
      What an animal still needs before it goes on the public site, and
      publishing it.
  - name: Animal day
    description: What was done for an animal today, what is due, and feedings.
  - 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: Costs
    description: >-
      What the rescue spends, on an animal or on itself: vet bills, food,
      supplies, boarding, each with its receipt in Documents, and what each
      animal has cost.
  - name: Rounds
    description: >-
      Daily rounds: a pass through every place an animal in care is housed, each
      place ticked as it is visited, signed off at the end.
  - name: Lost and found
    description: >-
      Reports of pets lost and found, sent by the public from the board on your
      site, read and put on the board by you.
  - name: Field visits
    description: >-
      Work out in the community: strays picked up, welfare checks, colony
      visits, pantry deliveries and owner support; and the TNR colonies a rescue
      cares for.
  - name: Field services
    description: >-
      For an organization that answers animal control calls: cases, with what
      was reported, where, the people and animals involved, the officer on it,
      every visit, call, notice and pickup, and the ordinances broken as
      warnings and citations, until each is closed with an outcome. Off until
      switched on, and the field team's.
  - name: Clinics
    description: >-
      Vaccine, microchip and spay or neuter clinics for the public's own pets:
      the pets on their owners' records, the clinic days, the services offered
      (sale items), and the appointments.
  - name: Behavior plans
    description: >-
      The work toward one goal for one animal: a goal, its phases, how success
      is measured, a lead and a review on a cadence, each review a task on the
      animal and each follow-up recorded. And the library a plan starts from.
  - name: Assessments
    description: >-
      Short assessments done on an animal as often as wanted, each scored
      question a line over time, and the ones your organization sets up. A
      question can fill the animal's Good with fields.
  - name: Enrichment and playgroups
    description: >-
      What an animal was given (walks, play, training, puzzles, time out of the
      kennel), its last time out, and playgroups: each dog's play rated and who
      it played with.
  - name: Behavior desk and case reviews
    description: >-
      What the behavior team has to do on one page, and case reviews: a serious
      outcome signed off by named people, decided by a person, never by the
      software.
  - name: Controlled drugs
    description: >-
      The controlled drugs given under your DEA registration: each bottle, every
      dose, waste and count, only added to. The printed, signed log stays the
      legal record.
  - 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: Adoption holds
    description: >-
      An animal held for one person for a while, in Adoption Pending, with its
      fee taken as a deposit; and how long a hold lasts and what becomes of its
      fee.
  - 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: Decision reasons
    description: >-
      Why an application is approved or denied, in your organization's words: a
      list for each decision.
  - name: Behavior attributes
    description: >-
      The catalog of behavioral 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 catalog
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: Medical protocols
    description: >-
      Your lists of what each species and age group is given, and when. Applying
      one adds ordinary medical records, due on their days.
  - name: Exam forms
    description: >-
      Forms filled on an animal in one go, such as an intake exam: each answer
      is saved as its own record (a weight, the microchip, medical records, one
      exam record of the findings, a note).
  - name: Clinic sheets
    description: >-
      One of your exam forms for the animals going to a clinic: printed with
      what is on file, typed in afterwards as a grid, and recorded as the form
      filled for each animal.
  - name: Handling levels
    description: >-
      Who may handle an animal, in your organization's words: anyone, trained
      volunteers and staff, or staff only.
  - name: Bites and quarantine
    description: An animal's bite reports, only added to, and the quarantine a bite starts.
  - name: Outcome reasons
    description: >-
      Why an animal was euthanized or died, in your organization's words, and
      whether one must be given.
  - name: Note types
    description: What an animal's notes are filed under, in your organization's words.
  - name: Text templates
    description: Words a note or a medical record's notes start from.
  - name: Jurisdictions
    description: >-
      The towns or counties your animals come from and go to, for a contract
      with each: the ZIP codes and town or city names that are each one, and the
      default a new arrival takes.
  - name: Foster reasons
    description: >-
      Why an animal goes to foster and why it came back: the reasons built in,
      the rescue's own, and whether each question is asked or required.
  - name: Certificate settings
    description: >-
      What a rabies or spay or neuter certificate prints beside its record: the
      rescue's text, whether the vet's signature prints, and each vet's license
      number and signature image.
  - 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: Pet food pantry
    description: >-
      Pet food given to people in your community: the households served and
      their pets, each visit and what went home, and what a month came to in
      pounds. Off until your organization switches it on, and what it keeps
      about the people it serves is your organization's choice.
  - 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: Event tickets
    description: >-
      Tickets to an event, sold on its public page: the ticket types and codes,
      the guest list, and checking guests in at the door.
  - 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: Auctions
    description: >-
      Gala auctions and the lots in them. An auction may be part of a campaign,
      so what it raises lands with the rest of that campaign's money, or stand
      on its own.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Funds and appeals
    description: >-
      What a giver said their money is for, and what made them give: two
      different questions, kept apart.
  - name: Sales
    description: >-
      What crosses the counter that is not an adoption fee or a gift: the things
      you sell, and each sale by card, cash or check.
  - 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.
  - name: Registry marks
    description: >-
      Where a flag from another rescue matches one of YOUR records. A mark is a
      pointer with no narrative on it: it says what kind of thing was filed and
      which identifier matched, and reading the flag itself goes through the
      flag endpoints, which decide for themselves who may see what.
  - name: Status
    description: >-
      What the public status page at status.rescueconsole.com says, in
      RescueConsole's own shape. Public, like the status page itself: no key is
      needed.
paths:
  /api/forms/submissions/{id}/surrender:
    parameters:
      - name: id
        in: path
        required: true
        description: The submission's record ID.
        schema:
          type: string
    post:
      tags:
        - Submissions
      summary: Answer a surrender request
      description: >-
        Accepts, waitlists or declines a surrender request; other kinds are
        refused. `accepted` with `animal` (its species, and a name if the
        answers lack one) adds the animal with an owner-surrender intake naming
        the person, who is added to People first if needed; `accepted` with
        `return_adoption_id`, one of the adoptions listed under
        `surrender.returning`, reverses that adoption instead and records the
        animal's return, with the note as the reason. Either way the animal is
        linked to the submission. Accepting is final (409 afterwards) and needs
        **write** on Animals as well. It waits on the request's checklist: while
        an open workflow run the request started has a required step pending
        (other than one whose Done when is `submission.surrender_decided_at`,
        which any answer ticks), `accepted` is refused with 409 and
        `steps_first`, after the person is added to People and before anything
        is recorded. `outcome: null` undoes a waitlist or a decline. Not on
        spam. Needs **write** on the area of the form's kind.
      operationId: answerSurrender
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - outcome
              properties:
                outcome:
                  type:
                    - string
                    - 'null'
                  enum:
                    - accepted
                    - waitlisted
                    - declined
                    - null
                note:
                  type:
                    - string
                    - 'null'
                  maxLength: 2000
                animal:
                  type: object
                  properties:
                    name:
                      type:
                        - string
                        - 'null'
                    species:
                      $ref: '#/components/schemas/Species'
                return_adoption_id:
                  type: string
            example:
              outcome: accepted
              animal:
                name: Pepper
                species: cat
              note: Cage free on Thursday.
      responses:
        '200':
          description: The submission, as Get one submission gives it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionDetail'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    Species:
      type: string
      enum:
        - dog
        - cat
        - rabbit
        - equine
        - small_mammal
        - large_mammal
        - bird
        - barnyard
        - fish
        - reptile
        - exotic
    SubmissionDetail:
      type: object
      required:
        - submission
        - fields
        - can_write
        - can_decide
      properties:
        submission:
          allOf:
            - $ref: '#/components/schemas/Submission'
            - type: object
              properties:
                animals:
                  type: array
                  description: >-
                    The animals the applicant picked, as they are now. One
                    deleted since is left out.
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type:
                          - string
                          - 'null'
                      species:
                        $ref: '#/components/schemas/Species'
                decided_by_name:
                  type:
                    - string
                    - 'null'
                  description: Who decided, by name.
        uploads:
          type: array
          description: >-
            The files the person sent for the form's files questions, oldest
            first. Read one with Get a file sent with a submission.
          items:
            type: object
            properties:
              id:
                type: string
              field_key:
                type: string
                description: The files question it was sent for.
              filename:
                type: string
                description: As it came off the person's device.
              content_type:
                type: string
              bytes:
                type: integer
              document_id:
                type:
                  - string
                  - 'null'
                description: >-
                  The document it became when the submission was added to
                  People; null before.
        fields:
          type: array
          description: >-
            The form's questions as they are today, in order, to label the
            answers. An answer to a question removed since has no label here.
          items:
            type: object
            required:
              - field_key
              - label
            properties:
              field_key:
                type: string
              label:
                type: string
        can_write:
          type: boolean
          description: Whether your key may change it.
        can_decide:
          type: boolean
          description: Whether it is a kind that is approved or rejected.
        surrender:
          type: object
          description: >-
            On a surrender request only: how it was answered, and the adoptions
            it may be undoing.
          properties:
            status:
              type:
                - string
                - 'null'
              enum:
                - accepted
                - waitlisted
                - declined
                - null
            note:
              type:
                - string
                - 'null'
            decided_at:
              type:
                - string
                - 'null'
              format: date-time
            decided_by_name:
              type:
                - string
                - 'null'
            animal_id:
              type:
                - string
                - 'null'
              description: The animal accepted.
            adoption_id:
              type:
                - string
                - 'null'
              description: The adoption reversed, when it came back.
            returning:
              type: array
              description: >-
                Your adoptions still standing whose animal has the microchip
                number on the request, or whose adopter has the email on it.
              items:
                type: object
                properties:
                  adoption_id:
                    type: string
                  animal_id:
                    type: string
                  animal_name:
                    type:
                      - string
                      - 'null'
                  adopted_on:
                    type:
                      - string
                      - 'null'
                    format: date
                  adopter_name:
                    type:
                      - string
                      - 'null'
                  matched_by:
                    type: array
                    items:
                      type: string
                      enum:
                        - microchip
                        - adopter
            can_accept:
              type: boolean
              description: >-
                Whether the reader may accept it: write on the form's area and
                on Animals.
            steps_first:
              type: array
              description: >-
                The checklist steps still to do before it can be accepted:
                required and pending, on open runs this request started, leaving
                out a step the answer itself ticks. Empty once it is accepted.
              items:
                type: object
                properties:
                  title:
                    type: string
                  workflow_name:
                    type: string
                    description: The checklist the step is on.
            share_consent:
              type: boolean
              description: >-
                Whether the person agreed to the request being shared with other
                rescues.
            share:
              type:
                - object
                - 'null'
              description: The request as last shared, if it has been.
              properties:
                id:
                  type: string
                audience:
                  type: string
                  enum:
                    - partners
                    - network
                status:
                  type: string
                  enum:
                    - open
                    - taken
                    - withdrawn
                shared_at:
                  type: string
                  format: date-time
                reached:
                  type: integer
                  description: How many rescues it matched when it was shared.
                taken_by_org_name:
                  type:
                    - string
                    - 'null'
                taken_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                priority_until:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: >-
                    Until when only the rescue that adopted the animal out sees
                    it, when its microchip matched one.
                priority_org_name:
                  type:
                    - string
                    - 'null'
                  description: That rescue's name.
    Submission:
      type: object
      description: >-
        One submission. The list also carries the form's title, address and
        kind, the application made from it, and the assignees; changing one
        returns the submission alone.
      additionalProperties: true
      required:
        - id
        - form_id
        - answers
        - status
        - submitted_at
      properties:
        id:
          type: string
        form_id:
          type: string
        answers:
          type: object
          description: >-
            What the person sent, as text, keyed by each question's field_key.
            Only questions the form asked are kept. An answer to a question
            removed since is still here.
          additionalProperties:
            type: string
        animal_ids:
          type: array
          description: >-
            The record IDs of the listed animals the applicant picked, in the
            order they picked them.
          items:
            type: string
        submitter_name:
          type:
            - string
            - 'null'
          description: The sender's name, taken from the answers.
        submitter_email:
          type:
            - string
            - 'null'
          description: The sender's email, taken from the answers.
        status:
          $ref: '#/components/schemas/SubmissionStatus'
        notes:
          type:
            - string
            - 'null'
          description: Your team's notes.
        reviewed_by_person_id:
          type:
            - string
            - 'null'
        reviewed_at:
          type:
            - string
            - 'null'
          format: date-time
        converted_to_type:
          type:
            - string
            - 'null'
          description: person once the submission is joined to one.
        converted_to_id:
          type:
            - string
            - 'null'
          description: The record ID of the person it is joined to.
        converted_how:
          type:
            - string
            - 'null'
          enum:
            - created
            - linked
            - null
          description: >-
            created when the person was made from this submission, linked when
            they were already on file. Null until the submission has a person,
            which happens when the address it carried confirms it (see
            verification_state) or when somebody adds them by hand.
        verification_state:
          type: string
          enum:
            - not_required
            - pending
            - verified
            - unreachable
          description: >-
            Whether the address on the submission has confirmed it was them. A
            public submission creates no person, no application and no checklist
            until it does. not_required: no email address on it, or somebody
            added the person by hand. pending: waiting, and verification_sent_at
            tells you whether the email has actually gone out. verified:
            confirmed, by them or by a member of staff adding them. unreachable:
            they have opted out of your email or the address bounced, so nobody
            is coming and it is yours to decide.
        verification_sent_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the confirmation email went out. Null while pending means it
            has not been sent: one goes to an address per hour, with a daily
            ceiling per organization, and POST .../verification sends it.
        verification_verified_at:
          type:
            - string
            - 'null'
          format: date-time
        decision:
          type:
            - string
            - 'null'
          enum:
            - approved
            - rejected
            - null
          description: Null until somebody decides, and after a decision is undone.
        decided_at:
          type:
            - string
            - 'null'
          format: date-time
        decided_by_person_id:
          type:
            - string
            - 'null'
        decision_note:
          type:
            - string
            - 'null'
        held_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When a failed check in a workflow put it on hold.
        hold_reason:
          type:
            - string
            - 'null'
        application_id:
          type:
            - string
            - 'null'
          description: The adoption or foster application made from it.
        submitted_at:
          type: string
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        form_title:
          type: string
          description: On the list, one submission, and convert.
        form_slug:
          type: string
          description: On the list, one submission, and convert.
        form_kind:
          $ref: '#/components/schemas/FormKind'
        application_status:
          type:
            - string
            - 'null'
          description: >-
            Where the application made from it stands, such as submitted,
            approved or denied. On the list and one submission.
        application_stage:
          type:
            - string
            - 'null'
          description: The application's stage key. On the list and one submission.
        application_stage_label:
          type:
            - string
            - 'null'
          description: The stage in your organization's words.
        assignees:
          type: array
          description: >-
            Who is working it, in the order they were assigned. On the list and
            one submission.
          items:
            $ref: '#/components/schemas/SubmissionAssignee'
        links:
          type: array
          description: Only on the one-submission read.
          items:
            $ref: '#/components/schemas/SubmissionLink'
    SubmissionStatus:
      type: string
      description: >-
        new until somebody reviews it; reviewed; converted once somebody
        converts it (see Convert a submission); spam, which is kept but left out
        of the list unless you ask for it. A submission caught by the spam trap
        on your public form arrives as spam. A submission joined to a person by
        itself when it arrived stays new, because nobody has reviewed it yet.
      enum:
        - new
        - reviewed
        - converted
        - spam
    FormKind:
      type: string
      description: >-
        What a form is for, which decides the area its submissions belong to and
        so which keys may read them. adoption_application, foster_application
        and surrender (a surrender request) are Animals; volunteer (a volunteer
        sign-up) is Shifts; donor is Fundraising; contact and general are
        People.
      enum:
        - adoption_application
        - foster_application
        - volunteer
        - donor
        - surrender
        - contact
        - general
    SubmissionAssignee:
      type: object
      required:
        - person_id
        - name
      properties:
        person_id:
          type: string
        name:
          type: string
    SubmissionLink:
      type: object
      description: >-
        Somebody a coordinator added to a submission AFTERWARDS. Not the same
        thing as the animals on the submission itself: those are what the sender
        ticked, and they are an ANSWER, which no API here will edit. These are
        what your team worked out later, and each one records who said so.
      properties:
        id:
          type: string
        entity_type:
          type: string
          enum:
            - person
            - animal
            - organization
        entity_id:
          type: string
          description: The record ID, which must be one of yours.
        entity_label:
          type: string
          nullable: true
          description: Their name, as it reads today. Null where the record has none.
        added_by_person_id:
          type: string
          nullable: true
          description: Who linked it.
        created_at:
          type: string
  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_.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.