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
labels
string
required

Comma-separated label names to apply. Matched case-insensitively against existing chat labels; labels that do not exist are created automatically.

Minimum string length: 1
Example:

"priority,follow-up"

chat_ids
string[]
required

Ids of the chats to update. 1-1 chat ids may omit the @c.us suffix — it is added automatically.

Minimum array length: 1
Example:
replace
boolean

When true (the default), the given labels replace all current labels of each chat. Pass false to append to the existing labels instead.

Example:

true

Response

Labels updated — no content