Restrict or open an inbox
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_restricted": false
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_restricted: false})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access', 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}/access"
payload = { "is_restricted": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"is_restricted": true,
"results": [
{
"id": "<string>",
"person_id": "<string>",
"role_key": "<string>",
"label": "<string>",
"created_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)"
}Inboxes
Restrict or open an inbox
Turns an inbox’s access list on or off. Setting is_restricted to false opens the inbox, and every conversation in it, to everyone who may read Communications; the rules stay on the list for when it is restricted again. Needs write on Communications.
PATCH
/
api
/
communications
/
inboxes
/
{id}
/
access
Restrict or open an inbox
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_restricted": false
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_restricted: false})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access', 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}/access"
payload = { "is_restricted": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"is_restricted": true,
"results": [
{
"id": "<string>",
"person_id": "<string>",
"role_key": "<string>",
"label": "<string>",
"created_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)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The inbox's ID.
Body
application/json