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
contact_ids
string[]
required

Phone numbers of the contacts to update: country code + number without symbols or spaces (e.g. 911111111111). The @c.us suffix is also accepted.

Minimum array length: 1
Minimum string length: 1
Example:
labels
string | null
required

Comma-separated list of labels to put on the contact (e.g. 'lead, priority'). Labels are matched case-insensitively and labels that do not exist yet are created automatically. This replaces all current labels of the contact — pass the full desired list. Pass null or an empty string to remove every label from the contacts.

Example:

"lead, priority"

Response

Labels updated — no content