curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/inboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "adoptions",
"display_name": "Adoptions",
"description": "Questions from adopters and applicants."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'adoptions',
display_name: 'Adoptions',
description: 'Questions from adopters and applicants.'
})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes', 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"
payload = {
"name": "adoptions",
"display_name": "Adoptions",
"description": "Questions from adopters and applicants."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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)"
}Create an inbox
Creates an inbox, and with it a new address mail can be sent to. It starts open to everyone who may read Communications. Needs write on Communications.
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/inboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "adoptions",
"display_name": "Adoptions",
"description": "Questions from adopters and applicants."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'adoptions',
display_name: 'Adoptions',
description: 'Questions from adopters and applicants.'
})
};
fetch('https://{organization}.rescueconsole.com/api/communications/inboxes', 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"
payload = {
"name": "adoptions",
"display_name": "Adoptions",
"description": "Questions from adopters and applicants."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Body
The inbox's own part of the address: 1 to 31 lowercase letters, digits and hyphens, starting with a letter or digit. It cannot be changed later. postmaster, abuse, hostmaster, webmaster, noreply, no-reply, bounces and mailer-daemon are reserved.
^[a-z0-9][a-z0-9-]{0,30}$1Response
The inbox.
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.