Put an animal on the public site
Marks the record public and, when its status is not one the public site shows, sets the readiness’s publish_status (Available for Adoption, or the first status that is public and in care). The status change is an ordinary one: it can end a foster placement and start a workflow. Refused with 409 while the photo or the description is missing (missing names them), when no status is both public and in care, or when the animal has left the rescue’s care. An animal already published is returned unchanged. The body is empty. Needs write on Animals.
POST
https://{organization}.rescueconsole.com
/
api
/
animals
/
animals
/
{id}
/
publish
Put an animal on the public site
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"animal": {
"status": "<string>",
"id": "<string>",
"species": "dog",
"intake_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"public_name": "<string>",
"breed": "<string>",
"variety": "<string>",
"sex": "male",
"dob_estimate": "2023-12-25",
"current_location_unit_id": "<string>",
"microchip_number": "<string>",
"microchip_vendor": "<string>",
"microchip_owner_registration": {
"vendor": "<string>",
"registry": "<string>",
"url": "<string>",
"adopter_note": "<string>",
"organization_note": "<string>"
},
"microchip_registry_verdict": {
"registry": "<string>",
"state": "closed",
"advice": "<string>",
"matched_on": "name"
},
"alt_names": [
"<string>"
],
"size": "small",
"color_primary": "<string>",
"color_secondary": "<string>",
"pattern": "<string>",
"coat_length": "<string>",
"intake_source": "stray",
"primary_vet_organization_id": "<string>",
"altered": "yes",
"altered_before_intake": true,
"altered_on": "2023-12-25",
"altered_veterinarian_person_id": "<string>",
"altered_clinic_organization_id": "<string>",
"adoption_fee_cents": 1,
"is_public": true,
"health_status": "<string>",
"description": "<string>",
"behavioral_traits": [
"<string>"
],
"medical_flags": [
"<string>"
],
"custom_fields": {},
"outcome_person_id": "<string>",
"outcome_date": "2023-12-25",
"good_with_children": 1,
"min_child_age": 9,
"good_with_adults": "all",
"good_with_seniors": 1,
"good_with_dogs": 1,
"good_with_cats": 1,
"good_with_farm_animals": 1,
"good_with_small_animals": 1,
"good_with_birds": 1,
"needs_fenced_yard": 1,
"ok_in_apartment": 1,
"needs_experienced_adopter": 1,
"max_hours_alone": 12,
"placement_notes": "<string>",
"house_trained": 1,
"crate_trained": 1,
"leash_trained": 1,
"declawed": 1,
"fiv_positive": 1,
"energy_level": "low",
"indoor_outdoor": "indoor",
"available_date": "2023-12-25",
"special_needs_description": "<string>",
"distinguishing_marks": "<string>",
"sponsorship_allowed": true,
"sponsorship_minimum_cents": 1,
"sponsorship_details": "<string>",
"previous_id": "<string>",
"photo_file_id": "<string>",
"status_review_on": "2023-12-25",
"tenant_id": "<string>",
"pet_id": "<string>",
"care_state": "in_care",
"tags": [
"<string>"
],
"transfer_id": "<string>",
"transfer_partner_name": "<string>",
"outcome_reasons": [
{
"id": "<string>",
"label": "<string>"
}
],
"no_chip_reason": "<string>",
"outcome_jurisdiction_id": "<string>",
"outcome_asilomar": "healthy",
"missing_kind": "lost"
},
"readiness": {
"animal_id": "<string>",
"live": true,
"in_care": true,
"ready": true,
"checks": [
{
"key": "photo",
"label": "<string>",
"ok": true,
"required": true,
"detail": "<string>"
}
],
"publish_status": {
"key": "<string>",
"label": "<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
Body
application/json
The body is of type object.
⌘I
Put an animal on the public site
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/animals/{id}/publish"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"animal": {
"status": "<string>",
"id": "<string>",
"species": "dog",
"intake_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"public_name": "<string>",
"breed": "<string>",
"variety": "<string>",
"sex": "male",
"dob_estimate": "2023-12-25",
"current_location_unit_id": "<string>",
"microchip_number": "<string>",
"microchip_vendor": "<string>",
"microchip_owner_registration": {
"vendor": "<string>",
"registry": "<string>",
"url": "<string>",
"adopter_note": "<string>",
"organization_note": "<string>"
},
"microchip_registry_verdict": {
"registry": "<string>",
"state": "closed",
"advice": "<string>",
"matched_on": "name"
},
"alt_names": [
"<string>"
],
"size": "small",
"color_primary": "<string>",
"color_secondary": "<string>",
"pattern": "<string>",
"coat_length": "<string>",
"intake_source": "stray",
"primary_vet_organization_id": "<string>",
"altered": "yes",
"altered_before_intake": true,
"altered_on": "2023-12-25",
"altered_veterinarian_person_id": "<string>",
"altered_clinic_organization_id": "<string>",
"adoption_fee_cents": 1,
"is_public": true,
"health_status": "<string>",
"description": "<string>",
"behavioral_traits": [
"<string>"
],
"medical_flags": [
"<string>"
],
"custom_fields": {},
"outcome_person_id": "<string>",
"outcome_date": "2023-12-25",
"good_with_children": 1,
"min_child_age": 9,
"good_with_adults": "all",
"good_with_seniors": 1,
"good_with_dogs": 1,
"good_with_cats": 1,
"good_with_farm_animals": 1,
"good_with_small_animals": 1,
"good_with_birds": 1,
"needs_fenced_yard": 1,
"ok_in_apartment": 1,
"needs_experienced_adopter": 1,
"max_hours_alone": 12,
"placement_notes": "<string>",
"house_trained": 1,
"crate_trained": 1,
"leash_trained": 1,
"declawed": 1,
"fiv_positive": 1,
"energy_level": "low",
"indoor_outdoor": "indoor",
"available_date": "2023-12-25",
"special_needs_description": "<string>",
"distinguishing_marks": "<string>",
"sponsorship_allowed": true,
"sponsorship_minimum_cents": 1,
"sponsorship_details": "<string>",
"previous_id": "<string>",
"photo_file_id": "<string>",
"status_review_on": "2023-12-25",
"tenant_id": "<string>",
"pet_id": "<string>",
"care_state": "in_care",
"tags": [
"<string>"
],
"transfer_id": "<string>",
"transfer_partner_name": "<string>",
"outcome_reasons": [
{
"id": "<string>",
"label": "<string>"
}
],
"no_chip_reason": "<string>",
"outcome_jurisdiction_id": "<string>",
"outcome_asilomar": "healthy",
"missing_kind": "lost"
},
"readiness": {
"animal_id": "<string>",
"live": true,
"in_care": true,
"ready": true,
"checks": [
{
"key": "photo",
"label": "<string>",
"ok": true,
"required": true,
"detail": "<string>"
}
],
"publish_status": {
"key": "<string>",
"label": "<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)"
}
