Triage a submission
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/forms/submissions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "reviewed",
"notes": "Called back on 18 September. Home visit on the 24th."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'reviewed',
notes: 'Called back on 18 September. Home visit on the 24th.'
})
};
fetch('https://{organization}.rescueconsole.com/api/forms/submissions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/forms/submissions/{id}"
payload = {
"status": "reviewed",
"notes": "Called back on 18 September. Home visit on the 24th."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"submission": {
"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)"
}Submissions
Triage a submission
Marks a submission reviewed, marks it spam (or back to new), keeps notes on it, or takes it off hold. Changing the status records the person who made your key, and now, as who reviewed it and when. The answers cannot be changed: they are what the person sent. Converted cannot be set here: use Convert a submission. Needs write on the area of the form’s kind.
PATCH
/
api
/
forms
/
submissions
/
{id}
Triage a submission
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/forms/submissions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "reviewed",
"notes": "Called back on 18 September. Home visit on the 24th."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'reviewed',
notes: 'Called back on 18 September. Home visit on the 24th.'
})
};
fetch('https://{organization}.rescueconsole.com/api/forms/submissions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/forms/submissions/{id}"
payload = {
"status": "reviewed",
"notes": "Called back on 18 September. Home visit on the 24th."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"submission": {
"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)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The submission's record ID.
Body
application/json
Response
The submission, as it now is. The form's title, the application and the assignees are not included.
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.
Show child attributes
Show child attributes