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.

Headers

x-phone
string
required

Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token.

Minimum string length: 1
Example:

"919876543210"

Path Parameters

chat_id
string
required

Unique id of the group chat, ending with @g.us. This endpoint only works on group chats — ids not ending with @g.us are rejected.

Minimum string length: 1
Example:

"120363000000000000@g.us"

Response

Result of the leave operation

Result of the leave operation as returned by the phone instance. Usually an empty object or a per-participant status map.