INinstantly
WorkspaceMember

Patch workspace member

Changed on

Requires one of the following scopes: workspace_members:update, workspace_members:all, all:update, all:all

patch/api/v2/workspace-members/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/workspace-members/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6d-939b-7056-9239-c4a682faa6fa

The ID of the item to update

Request body

nicknamestring nullable

Private workspace member nickname visible only to the workspace owner

role'owner' | 'admin' | 'editor' | 'view' | 'client'

THe role of the workspace member defining their access level. While the "owner" role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.

Example request

{
  "nickname": "Finance lead",
  "role": "editor"
}

Response

The updated Workspace Member

idstring uuid required

Unique identifier for the workspace member

emailstring email required

Email address of the workspace member

user_idstring uuid required

User ID of the workspace member

user_emailstring email nullable

Email address of the user

nicknamestring nullable

Private workspace member nickname visible only to the workspace owner

picture_urlstring nullable

URL of the profile picture the user uploaded, if any. Returned when listing workspace members.

role'owner' | 'admin' | 'editor' | 'view' | 'client' required

THe role of the workspace member defining their access level. While the "owner" role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.

timestamp_createdstring date-time required

Timestamp when the workspace member was created

workspace_idstring uuid required

ID of the workspace this member belongs to

acceptedboolean required

Whether the member has accepted the workspace invitation

issuer_idstring uuid nullable

ID of the user who added this member to the workspace

permissionsstring[] nullable

The permissions for this workspace member. Used in the app to restrict access to certain sections

Example response

{
  "id": "01a19e6d-50ef-7531-9951-6210a7d6f40a",
  "email": "user@example.com",
  "user_id": "01a19e6d-50ef-7531-9951-62113ee0823d",
  "user_email": "user@example.com",
  "nickname": "Finance lead",
  "name": {
    "first": "John",
    "last": "Smith"
  },
  "picture_url": "https://example.com/profile-picture.png",
  "role": "editor",
  "timestamp_created": "2026-11-02T22:42:06.703Z",
  "workspace_id": "01a19e6d-50ef-7531-9951-6212b7c4f081",
  "issuer_id": "01a19e6d-50ef-7531-9951-621308b4ef54",
  "permissions": [
    "unibox.all"
  ]
}

Changes

  • c781051105a8Revision changes
    • warning

      added the new websiteChat.manage enum value to the / response property for the response status

    • warning

      added the new websiteChat.view enum value to the / response property for the response status

    • info

      added the optional property to the response with the status