curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/organizations/organizations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"relationship": "past_client",
"is_primary_vet": false,
"notes": "Closed their Portland clinic in August."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
relationship: 'past_client',
is_primary_vet: false,
notes: 'Closed their Portland clinic in August.'
})
};
fetch('https://{organization}.rescueconsole.com/api/organizations/organizations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/organizations/organizations/{id}"
payload = {
"relationship": "past_client",
"is_primary_vet": False,
"notes": "Closed their Portland clinic in August."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"kind": "veterinary_practice",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"address": {
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>"
},
"notes": "<string>",
"is_active": true,
"is_emergency": true,
"is_primary_vet": true,
"relationship": "prospect",
"relationship_since": "2023-12-25",
"industry_code": "<string>",
"industry_label": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"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 an organization
Send only what changes; null clears the email, phone, website or notes. There is no delete: send is_active: false to archive an organization, which also takes its primary vet flag away. A veterinary practice with either flag set cannot change kind unless both flags are cleared, in this request or before it (409). Changing relationship moves relationship_since to today unless you send one; sending the relationship it already has keeps its date, and clearing it clears the date. Send industry_code and industry_label together: sending one clears the other. An address or phone sent here changes the main location too, or makes one. Needs write on Organizations.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/organizations/organizations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"relationship": "past_client",
"is_primary_vet": false,
"notes": "Closed their Portland clinic in August."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
relationship: 'past_client',
is_primary_vet: false,
notes: 'Closed their Portland clinic in August.'
})
};
fetch('https://{organization}.rescueconsole.com/api/organizations/organizations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/organizations/organizations/{id}"
payload = {
"relationship": "past_client",
"is_primary_vet": False,
"notes": "Closed their Portland clinic in August."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"kind": "veterinary_practice",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"address": {
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>"
},
"notes": "<string>",
"is_active": true,
"is_emergency": true,
"is_primary_vet": true,
"relationship": "prospect",
"relationship_since": "2023-12-25",
"industry_code": "<string>",
"industry_label": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"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 organization's ID.
Body
Cannot be emptied.
What the organization is.
veterinary_practice, rescue, shelter, supplier, employer, government, other The main phone number, kept as you send it. It is also the main location's phone.
Every part is optional, and a key not listed here is refused. An empty or null part is removed.
Show child attributes
Show child attributes
Veterinary practices only: it takes emergencies.
Veterinary practices only: the practice you use by default. One organization at most has it, so setting it takes it from the other.
What the organization is to you, or null for nothing yet.
prospect, active_client, past_client, partner, supplier, competitor, null The day the relationship began. Today when the relationship changes, unless you send it.
A NAICS or SIC code, 12 characters at most.
12What the industry code means, 160 characters at most.
160false archives the organization: the list leaves it out unless asked, and it loses the primary vet flag. true brings it back.
Response
The organization, as it now is.
What the organization is.
veterinary_practice, rescue, shelter, supplier, employer, government, other Every part is optional, and a key not listed here is refused. An empty or null part is removed.
Show child attributes
Show child attributes
false when it is archived.
Always false for anything but a veterinary practice.
Always false for anything but a veterinary practice.
prospect, active_client, past_client, partner, supplier, competitor, null