Sign in
Board Memberships

Create board membership

Creates a board membership within a board. Requires project manager permissions.

post/boards/{boardId}/board-memberships

Request

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

Path parameters

boardIdstring required
Example:1357158568008091264

ID of the board to create the board membership in

Request body

userIdstring required

ID of the user who is a member of the board

role'editor' | 'viewer' required

Role of the user in the board

canCommentboolean nullable

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

Example request

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

Response

Board membership created 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.