---
title: "Invite Members"
method: POST
path: "/members/invite"
tags: ["members"]
---

# Invite Members

`POST /members/invite`

Invite one or more members to the organization. Optionally set role and default access (labels and orgPhones).

## Request body

- object
  - `emails` string[], required — Array of email addresses to invite
  - `role` string — Role for invited users. Allowed values are `admin` or `member`. Defaults to `member`.
  - `labels` string[], nullable — Label names to grant access to a member(applies to `member` role). You can provide the value as `null` if you want to give access to all labels.
  - `orgPhones` string[], nullable — Phone numbers (without @c.us) to grant access to a member(applies to `member` role). You can provide the value as `null` if you want to give access to all phone numbers.

## Response `200`

200 OK

- object
  - `addedMember` object[] — The list of added members
    - `created_at` string — Timestamp when the member record was created
    - `email` string — Email address of the invited member
    - `user_id` string, nullable — User ID if the member has accepted the invite
    - `invited_at` string — Timestamp when the member was invited
    - `invited_by` string, nullable — ID of the user who sent the invitation
    - `org_id` string — Organization ID that the member belongs to
    - `role` string — Role assigned to the member (admin or member)
    - `member_image` string, nullable — Profile image URL of the member
    - `member_name` string, nullable — Display name of the member
    - `is_active` boolean — Whether the member account is active
    - `member_color` string, nullable — Color code assigned to the member for UI display
    - `label_ids` string[] — Array of label IDs the member has access to
    - `org_phones` string[] — Array of phone numbers the member has access to
    - `is_owner` boolean, nullable — Whether the member is an organization owner
    - `preferences` object — User interface preferences
      - `left_sidebar_open` boolean — Whether left sidebar is open by default
      - `right_sidepanel_open` boolean — Whether right sidepanel is open by default
      - `sync_wa_unread_count` boolean — Whether to sync WhatsApp unread count
    - `is_online` boolean, nullable — Whether the member is currently online
    - `member_metadata` object — Additional custom metadata for the member

---

[API](https://skmtc.net/periskope/apis/api-local.md) · [All operations](https://skmtc.net/periskope/apis/api-local/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/periskope/api-local/revisions/f2738ced87d8/schema)