v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

members

Invite Members

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

post/members/invite

Request body

emailsstring[] required

Array of email addresses to invite

rolestring

Role for invited users. Allowed values are admin or member. Defaults to member.

labelsstring[] 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.

orgPhonesstring[] 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.

Example request

{
  "emails": [
    "michael@dundermifflin.com",
    "dwight@dundermifflin.com"
  ],
  "role": "member",
  "labels": [
    "Sales",
    "Support"
  ],
  "orgPhones": [
    "918824248940"
  ]
}

Response

200 OK

Example response

{
  "addedMember": [
    {
      "created_at": "2025-11-14T07:30:47.873008+00:00",
      "email": "test@example.com",
      "invited_at": "2025-11-14T07:30:47.873008+00:00",
      "org_id": "03a52dbe-b8af-47c5-9fd1-e5a622680cad",
      "role": "member",
      "is_active": true,
      "member_color": "#DB2777",
      "label_ids": [
        "label-uvzfbjfgwjuphhff"
      ],
      "org_phones": [
        "918824248940@c.us"
      ],
      "preferences": {
        "right_sidepanel_open": true,
        "sync_wa_unread_count": true
      },
      "member_metadata": {}
    }
  ]
}