Let someone read an inbox
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role_key": "adoption_counselor"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({role_key: 'adoption_counselor'})
};
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 = { "role_key": "adoption_counselor" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Inboxes
Let someone read an inbox
Adds a person, or everyone with a role, to an inbox’s access list. The first rule on an inbox restricts it: from then on only the people and roles on the list may read it, and everyone else loses sight of its conversations at once. Whoever holds your organization’s Organization admin role reads every inbox, whatever its list says. Needs write on Communications.
POST
/
api
/
communications
/
inboxes
/
{id}
/
access
Let someone read an inbox
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/inboxes/{id}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role_key": "adoption_counselor"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({role_key: 'adoption_counselor'})
};
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 = { "role_key": "adoption_counselor" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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)"
}{
"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