Class BoardMember`Internal`

Contains the current user's board membership details. The current user could be different from the board owner.

Hierarchy

BoardMember
- BoardMember

Index

Properties

boardId id name role? type

Methods

Properties

boardId

boardId: string

id

id: string

Unique identifier (ID) of the user.

name

name: string

Name of the user.

`Optional` role

role?: string

Role of the board member.

type

type: string

Type of the object that is returned. In this case, type returns board_member.

Methods

update

update(boardMemberChanges: BoardMemberChanges): Promise<void>
Updates the role of a board member.
Required scope
boards:write
Rate limiting
<a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2

Summary
Update board member
Parameters
- boardMemberChanges: BoardMemberChanges
Returns Promise<void>
- Defined in highlevel/index.ts:777