Preview a contract template
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'adoption',
entity_id: '2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
signer_name: 'Dana Whitfield'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview"
payload = {
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"body": "<string>",
"unresolved_fields": [
"<string>"
],
"values": {},
"body_blocks": [
{
"type": "p",
"runs": [
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
],
"items": [
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
],
"level": 1,
"rows": [
[
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
]
],
"src": "<string>",
"alt": "<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)"
}Contract templates
Preview a contract template
The template filled in from a real record, without signing anything, and the merge fields nothing fills. Without a record, only {{date}} and the signer’s name you send are filled. Needs write on Animals.
POST
/
api
/
animals
/
contract-templates
/
{id}
/
preview
Preview a contract template
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'adoption',
entity_id: '2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
signer_name: 'Dana Whitfield'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contract-templates/{id}/preview"
payload = {
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"body": "<string>",
"unresolved_fields": [
"<string>"
],
"values": {},
"body_blocks": [
{
"type": "p",
"runs": [
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
],
"items": [
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
],
"level": 1,
"rows": [
[
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
]
],
"src": "<string>",
"alt": "<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 template's ID.
Body
application/json
Response
The contract as it would read.