curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Adoptions team",
"is_default": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: 'Adoptions team', is_default: true})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/inboxes/{id}"
payload = {
"display_name": "Adoptions team",
"is_default": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"is_default": true,
"is_active": true,
"is_restricted": true,
"address": "jsmith@example.com",
"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 inbox
Changes an inbox’s display name or description, retires or restores it, or makes it the default (the one that was the default stops being it). The name cannot be changed, because it is the address (409): create a new inbox instead. Needs write on Communications.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Adoptions team",
"is_default": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: 'Adoptions team', is_default: true})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/inboxes/{id}"
payload = {
"display_name": "Adoptions team",
"is_default": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"is_default": true,
"is_active": true,
"is_restricted": true,
"address": "jsmith@example.com",
"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 inbox's ID.
Body
Response
The inbox, as it now is.
The inbox's own part of the address. It cannot be changed.
What people see it called.
Mail to your organization's bare address arrives here, and replies to email sent with Send an email come back here.
false once retired: mail sent to its address is turned away, and it cannot be sent from.
Whether only the people and roles on its access list may read it.
The full address to publish, or to forward your own mail to.