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.

Path Parameters

chat_id
string
required

Unique id of the chat. For 1-1 chats, country code + number optionally suffixed with @c.us (e.g. 922222222222@c.us — the suffix is added automatically when omitted); for groups, the id ending with @g.us.

Minimum string length: 1
Example:

"120363000000000000@g.us"

Body

application/json
is_agent_allowed
boolean

Whether the AI agent may reply to messages in this chat. Overrides the org-wide default for this chat.

Example:

true

is_flagging_allowed
boolean

Whether AI flagging may flag messages in this chat.

Example:

true

Response

The effective AI settings of the chat

chat_id
string

Id of the chat the settings apply to

Example:

"120363000000000000@g.us"

is_agent_allowed
boolean

Effective agent permission for this chat

Example:

true

is_flagging_allowed
boolean

Effective flagging permission for this chat

Example:

true