curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/forms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_published": true,
"success_message": "Thank you. We will be in touch within two days."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_published: true,
success_message: 'Thank you. We will be in touch within two days.'
})
};
fetch('https://{organization}.rescueconsole.com/api/forms/{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/{id}"
payload = {
"is_published": True,
"success_message": "Thank you. We will be in touch within two days."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"form": {
"id": "<string>",
"slug": "<string>",
"title": "<string>",
"form_kind": "adoption_application",
"is_published": true,
"description": "<string>",
"success_message": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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)"
}Change a form
Send only what changes. This is also how a form is published: is_published: true puts it on your public website, at /f/ followed by its address, where anyone can fill it in; false takes it down. A form with no questions cannot be published. Changing the kind changes who can read the submissions it already has, so it needs write on the new kind’s area as well as the old one. Needs write on the area of the form’s kind; a form your key may not read answers 404.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/forms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_published": true,
"success_message": "Thank you. We will be in touch within two days."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_published: true,
success_message: 'Thank you. We will be in touch within two days.'
})
};
fetch('https://{organization}.rescueconsole.com/api/forms/{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/{id}"
payload = {
"is_published": True,
"success_message": "Thank you. We will be in touch within two days."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"form": {
"id": "<string>",
"slug": "<string>",
"title": "<string>",
"form_kind": "adoption_application",
"is_published": true,
"description": "<string>",
"success_message": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The form's record ID, not its address.
Body
Send at least one field. Null or an empty string clears description or success_message.
Cannot be empty.
A new address, made the same way as on create. The old address stops working.
true publishes the form, false takes it down. A form with no questions cannot be published.
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.
adoption_application, foster_application, volunteer, donor, surrender, contact, general Response
The form, as it now is. Its questions are not included.
Show child attributes
Show child attributes