Record a signed contract
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/contracts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"template_id": "e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b",
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield",
"signer_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"signer_email": "dana.whitfield@contoso.com",
"media_release": true,
"consent_acknowledged": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template_id: 'e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b',
entity_type: 'adoption',
entity_id: '2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
signer_name: 'Dana Whitfield',
signer_person_id: 'b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e',
signer_email: 'dana.whitfield@contoso.com',
media_release: true,
consent_acknowledged: true
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contracts"
payload = {
"template_id": "e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b",
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield",
"signer_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"signer_email": "dana.whitfield@contoso.com",
"media_release": True,
"consent_acknowledged": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"signature": {
"id": "<string>",
"contract_name": "<string>",
"contract_version": "<string>",
"signer_name": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"entity_type": "adoption",
"entity_id": "<string>",
"is_voided": true,
"template_id": "<string>",
"contract_body": "<string>",
"contract_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>"
}
],
"signer_person_id": "<string>",
"signer_email": "<string>",
"consent_acknowledged": true,
"recorded_by_person_id": "<string>",
"media_release": 1,
"application_id": "<string>",
"adoption_ids": [
"<string>"
],
"approved_by_person_id": "<string>",
"approved_by_name": "<string>",
"completed_where_kind": "location",
"completed_where_id": "<string>",
"completed_where_label": "<string>",
"payment_method": "<string>",
"payment_instructions": "<string>",
"voided_at": "2023-11-07T05:31:56Z",
"voided_by_person_id": "<string>",
"void_reason": "<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)"
}Signed contracts
Record a signed contract
Records a contract signed on an adoption, a foster placement or an intake. Its merge fields are filled from the record now, and the text as it then reads is kept on the signature for good: changing the template later does not change it. The typed name is the signature, and consent to sign electronically must be recorded. A contract with a merge field nothing fills is refused, and the refusal names them in unresolved_fields. Signed on an adoption that is active, it fills in the adoption’s contract record where it is empty. The person who made the key is recorded as the team member who took the signature. Needs write on Animals.
POST
/
api
/
animals
/
contracts
Record a signed contract
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/contracts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"template_id": "e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b",
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield",
"signer_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"signer_email": "dana.whitfield@contoso.com",
"media_release": true,
"consent_acknowledged": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template_id: 'e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b',
entity_type: 'adoption',
entity_id: '2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
signer_name: 'Dana Whitfield',
signer_person_id: 'b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e',
signer_email: 'dana.whitfield@contoso.com',
media_release: true,
consent_acknowledged: true
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contracts"
payload = {
"template_id": "e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b",
"entity_type": "adoption",
"entity_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"signer_name": "Dana Whitfield",
"signer_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"signer_email": "dana.whitfield@contoso.com",
"media_release": True,
"consent_acknowledged": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"signature": {
"id": "<string>",
"contract_name": "<string>",
"contract_version": "<string>",
"signer_name": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"entity_type": "adoption",
"entity_id": "<string>",
"is_voided": true,
"template_id": "<string>",
"contract_body": "<string>",
"contract_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>"
}
],
"signer_person_id": "<string>",
"signer_email": "<string>",
"consent_acknowledged": true,
"recorded_by_person_id": "<string>",
"media_release": 1,
"application_id": "<string>",
"adoption_ids": [
"<string>"
],
"approved_by_person_id": "<string>",
"approved_by_name": "<string>",
"completed_where_kind": "location",
"completed_where_id": "<string>",
"completed_where_label": "<string>",
"payment_method": "<string>",
"payment_instructions": "<string>",
"voided_at": "2023-11-07T05:31:56Z",
"voided_by_person_id": "<string>",
"void_reason": "<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)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Body
application/json
Available options:
adoption, foster_assignment, animal_intake The adoption, foster placement or intake it is signed on.
The name the signer typed. The typed name is the signature.
The signer agreed to sign electronically. Must be true.
Available options:
true Who signed, when they are on file.
The media release answer, given at signing. It fills {{media_release}}.
Response
The signed contract, with its text.
A signed contract. It is never changed or deleted: a mistaken one is voided, with a reason, and stays.
Show child attributes
Show child attributes