Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
members

Update Member Access

Update access (labels and org phones) for multiple members with role 'member'. At least one of labels or orgPhones must be provided.

patch/members/access

Request body

emailsstring[] required
labelsstring[] nullable

Label names to grant access to. Null clears access

orgPhonesstring[] nullable

Phone numbers (without @c.us). Null clears access

Example request

{
  "emails": [
    "test@example.com"
  ],
  "labels": [
    "Sales"
  ],
  "orgPhones": [
    "918824248940"
  ]
}

Response

200 OK

created_atstring

Timestamp when the member record was created

emailstring

Email address of the member

user_idstring nullable

User ID if the member has accepted the invite

invited_atstring

Timestamp when the member was invited

invited_bystring nullable

ID of the user who sent the invitation

org_idstring

Organization ID that the member belongs to

rolestring

Role assigned to the member (admin or member)

member_imagestring nullable

Profile image URL of the member

member_namestring nullable

Display name of the member

is_activeboolean

Whether the member account is active

member_colorstring nullable

Color code assigned to the member for UI display

label_idsstring[]

Array of label IDs the member has access to

org_phonesstring[]

Array of phone numbers the member has access to

is_ownerboolean nullable

Whether the member is an organization owner

is_onlineboolean nullable

Whether the member is currently online

member_metadataobject

Additional custom metadata for the member

Example response

[
  {
    "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": {}
  }
]