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"

Response

The new invite link of the group

The response is proxied from the phone instance and always carries the new invite_link; additional chat fields may be included.

The freshly generated WhatsApp invite link of the group

Example:

"https://chat.whatsapp.com/invite/AAAAAAAAAAAAAAAAAAAAAA"