Sign in
workspace.members

Create a workspace member

Creates a new workspace member.

post/workspaces/{id}/members

Path parameters

idstring cuid required

The ID of the item

Example:cmf41ajzv003706un4i99q19z

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Request body

userIdstring cuid required

Identifier of the user that should be added to the workspace.

Example request

{
  "userId": "cmf41ajzv003706un4i99q1a0"
}

Response

Workspace member created successfully

createdAtstring date-time required

The date and time when the workspace membership was created. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

updatedAtstring date-time required

The date and time when the workspace membership was last updated. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

workspaceIdstring cuid required

The identifier of the workspace the member belongs to.

isMutedboolean required

Whether the member has muted notifications for the workspace.

userIdstring cuid required

Identifier of the user that is a member of the workspace.

Example response

{
  "createdAt": "2024-05-14T08:30:00Z",
  "updatedAt": "2024-06-01T12:00:00Z",
  "workspaceId": "cmf41ajzv003706un4i99q19z",
  "userId": "cmf41ajzv003706un4i99q1a0",
  "user": {
    "id": "cmf41ajzv003706un4i99q1a0",
    "email": "frida@example.com",
    "firstName": "Frida",
    "lastName": "Meyer"
  }
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • 80748f72965e1See the full diff
    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added