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

Optional. Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to let the API select an eligible phone automatically — within the token's phone scopes and connected; chat actions use a phone that has the chat (a group admin where required), message actions use the phone the message belongs to.

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"

Body

application/json
participants
(string | null)[]
required

Phone numbers of the participants (country code + number, e.g. 922222222222)

Minimum array length: 1

Phone number of the participant, as country code + number without symbols or spaces

Minimum string length: 1
Example:

"922222222222"

Example:

Response

Outcome per participant, keyed by contact_id

Outcome per participant, keyed by the participant contact_id (@c.us)

{key}
object

Outcome of a group participant operation (add/promote/demote/remove) for a single participant.