---
title: "Patch workspace member"
method: PATCH
path: "/api/v2/workspace-members/{id}"
tags: ["WorkspaceMember"]
---

# Patch workspace member

`PATCH /api/v2/workspace-members/{id}`

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

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `nickname` string, 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.

## Response `200`

The updated Workspace Member

- WorkspaceMember — A member of a workspace with associated user details
  - `id` string, uuid, required — Unique identifier for the workspace member
  - `email` string, email, required — Email address of the workspace member
  - `user_id` string, uuid, required — User ID of the workspace member
  - `user_email` string, email, nullable — Email address of the user
  - `nickname` string, nullable — Private workspace member nickname visible only to the workspace owner
  - `name` object
    - `first` string — Workspace member first name
    - `last` string — Workspace member last name
  - `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_created` string, date-time, required — Timestamp when the workspace member was created
  - `workspace_id` string, uuid, required — ID of the workspace this member belongs to
  - `accepted` boolean, required — Whether the member has accepted the workspace invitation
  - `issuer_id` string, uuid, nullable — ID of the user who added this member to the workspace
  - `permissions` string[], nullable — The permissions for this workspace member. Used in the app to restrict access to certain sections

## Other responses

- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

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