Sign in
Board Memberships

Update board membership

Updates a board membership. Requires project manager permissions.

patch/board-memberships/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/board-memberships/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the board membership to update

Request body

role'editor' | 'viewer'

Role of the user in the board

canCommentboolean nullable

Whether the user can comment on cards (applies only to viewers)

Example request

{
  "role": "editor",
  "canComment": true
}

Response

Board membership updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "projectId": "1357158568008091265",
    "boardId": "1357158568008091266",
    "userId": "1357158568008091267",
    "role": "editor",
    "canComment": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.