Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Body

application/json
access
object | null
required

Map of workspace member emails to access flags. Set an email to true to grant the member access to the chats, false to revoke it. Pass null or an empty object together with replace true to remove every access override from the chats; without replace an empty map changes nothing.

Example:
chat_ids
string[]
required

Ids of the chats whose access overrides to update

Minimum array length: 1
Example:
replace
boolean

When true, the existing access overrides of each chat are fully replaced with the given access map (an empty or null map then removes every override). Defaults to false (the map is merged into the existing overrides; an empty or null map changes nothing).

Example:

false

Response

Chat access overrides updated — no content