Skip to main content
POST
Let someone read an inbox

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The inbox's ID.

Body

application/json

Exactly one of person_id or role_key.

person_id
string

A person in your organization.

role_key
string

One of your organization's role keys, built in (such as adoption_counselor) or your own.

Response

The access list, as it now is.

is_restricted
boolean
required

Whether the list applies. When false, everyone who may read Communications may read this inbox.

results
object[]
required