curl --request POST \
  --url https://{organization}.rescueconsole.com/api/forms/submissions/{id}/convert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "id": "<string>",
  "form_id": "<string>",
  "answers": {},
  "status": "new",
  "submitted_at": "2023-11-07T05:31:56Z",
  "animal_ids": [
    "<string>"
  ],
  "submitter_name": "<string>",
  "submitter_email": "<string>",
  "notes": "<string>",
  "reviewed_by_person_id": "<string>",
  "reviewed_at": "2023-11-07T05:31:56Z",
  "converted_to_type": "<string>",
  "converted_to_id": "<string>",
  "converted_how": "created",
  "decision": "approved",
  "decided_at": "2023-11-07T05:31:56Z",
  "decided_by_person_id": "<string>",
  "decision_note": "<string>",
  "held_at": "2023-11-07T05:31:56Z",
  "hold_reason": "<string>",
  "application_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "form_title": "<string>",
  "form_slug": "<string>",
  "form_kind": "adoption_application",
  "application_status": "<string>",
  "application_stage": "<string>",
  "application_stage_label": "<string>",
  "assignees": [
    {
      "person_id": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Submissions

Convert a submission

Joins a submission to the person who sent it and marks it converted. Send an empty object to make a new person from it: their name, email, and answers to questions about the person, and for a volunteer, foster, adoption or donor form the matching role (volunteer, foster, adopter or donor). That needs write on People, and is refused with 409 when somebody with the same email is already on file; the refusal carries their person_id, so you can link instead. Send a person_id to link a person already on file; that needs read on People. Either way it also needs write on the area of the form’s kind. A submission already joined to a person is refused with 409, and that includes one with an email, which is joined to a person by itself when it arrives (see converted_how). Once joined, any workflow your organization set to run when such a form is received starts for the person, then any set to run on a decision already made, and an adoption or foster form becomes its application record.

POST

api

forms

submissions

{id}

convert

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/forms/submissions/{id}/convert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "id": "<string>",
  "form_id": "<string>",
  "answers": {},
  "status": "new",
  "submitted_at": "2023-11-07T05:31:56Z",
  "animal_ids": [
    "<string>"
  ],
  "submitter_name": "<string>",
  "submitter_email": "<string>",
  "notes": "<string>",
  "reviewed_by_person_id": "<string>",
  "reviewed_at": "2023-11-07T05:31:56Z",
  "converted_to_type": "<string>",
  "converted_to_id": "<string>",
  "converted_how": "created",
  "decision": "approved",
  "decided_at": "2023-11-07T05:31:56Z",
  "decided_by_person_id": "<string>",
  "decision_note": "<string>",
  "held_at": "2023-11-07T05:31:56Z",
  "hold_reason": "<string>",
  "application_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "form_title": "<string>",
  "form_slug": "<string>",
  "form_kind": "adoption_application",
  "application_status": "<string>",
  "application_stage": "<string>",
  "application_stage_label": "<string>",
  "assignees": [
    {
      "person_id": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

string

required

The submission's record ID.

Body

application/json

person_id

string

Link this person, already on file, instead of making a new one.

Response

The submission, as it now is, with its form's title, address and kind. It is not wrapped in a submission object, and has no assignees or application status.

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.

string

required

form_id

string

required

answers

object

required

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.

Show child attributes

status

enum<string>

required

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.

Available options:

new,

reviewed,

converted,

spam

submitted_at

string<date-time>

required

animal_ids

string[]

The record IDs of the listed animals the applicant picked, in the order they picked them.

submitter_name

string | null

The sender's name, taken from the answers.

submitter_email

string | null

The sender's email, taken from the answers.

notes

string | null

Your team's notes.

reviewed_by_person_id

string | null

reviewed_at

string<date-time> | null

converted_to_type

string | null

person once the submission is joined to one.

converted_to_id

string | null

The record ID of the person it is joined to.

converted_how

enum<string> | null

created when the person was made from this submission, linked when they were already on file. A submission with an email is joined to a person by itself when it arrives: to the person with that email, or to a new one.

Available options:

created,

linked,

null

decision

enum<string> | null

Null until somebody decides, and after a decision is undone.

Available options:

approved,

rejected,

null

decided_at

string<date-time> | null

decided_by_person_id

string | null

decision_note

string | null

held_at

string<date-time> | null

When a failed check in a workflow put it on hold.

hold_reason

string | null

application_id

string | null

The adoption or foster application made from it.

updated_at

string<date-time> | null

form_title

string

On the list, one submission, and convert.

form_slug

string

On the list, one submission, and convert.

form_kind

enum<string>

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.

Available options:

adoption_application,

foster_application,

volunteer,

donor,

surrender,

contact,

general

application_status

string | null

Where the application made from it stands, such as submitted, approved or denied. On the list and one submission.

application_stage

string | null

The application's stage key. On the list and one submission.

application_stage_label

string | null

The stage in your organization's words.

assignees

object[]

Who is working it, in the order they were assigned. On the list and one submission.

Show child attributes

Using the API

Endpoints

Convert a submission

Authorizations

Path Parameters

Body

Response