client.org.addMember

Add a member to an organisation.

Signature

class Client {
  org: {
    addMember(orgId: string, userId: string, role: string): Promise<{ success: boolean }>
  }
}

Name Type Required Notes

Name	Type	Required	Notes
`orgId`	string	yes	Organisation ID
`userId`	string	yes	User ID to add
`role`	string	yes	Role: `admin` , `member` , `viewer`

orgId

string

yes

Organisation ID

userId

string

yes

User ID to add

role

string

yes

Role:

admin

member

viewer

Error	Condition
`AuthError`	Insufficient permissions
`NotFoundError`	Organisation or user not found
`ConflictError`	User is already a member

await bf.org.addMember('org_abc', 'user_xyz', 'member')

Admin only — only org admins can add members
Role changes — to change a role, remove and re-add the member with the new role

{auto-injected}