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

Email addresses to invite. Emails that already belong to the org are skipped and reported in the errors array of the response instead of failing the request.

Minimum array length: 1
Example:
role
enum<string>

Role given to every invitee. Defaults to 'member'. Admins have universal access, so labels and orgPhones are not applied to admin invites.

Available options:
admin,
member
Example:

"member"

labels
string[] | null

Names (not ids) of chat labels to scope the new members’ chat access to. Matched case-insensitively against the org’s existing chat labels — unknown names reject the whole request, create the labels first. Applied only when role is member.

Example:
orgPhones
string[] | null

Phone numbers to scope the new members’ chat access to, as country code + number without symbols or spaces (e.g. 911111111111) — the @c.us suffix is optional. Every phone must already exist in the org, otherwise the whole request is rejected. Applied only when role is member.

Example:

Response

The added members and any per-email failures

addedMembers
object[]

The newly created member rows, with label_ids and org_phones already reflecting any labels/orgPhones passed in the request (member invites only). Empty when every email already existed or the user limit was reached.

errors
object[]

Per-email failures: emails that already belong to the org, invite emails that could not be sent, or a single email: null entry when the org’s user limit was reached (in which case nobody is added)