Skip to main content
PATCH
Change a member’s role or seat

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Scopes

members:write

Path Parameters

member
string
required

The member id, from list_members.

Required string length: 1 - 60

Body

application/json
role
enum<string> | null
Available options:
admin,
member
seat
enum<string> | null

advisor or support. An advisor seat can be a client’s advisor; a support seat works with every client but cannot be anyone’s advisor.

Available options:
advisor,
support

Response

Success.

object
enum<string>
required
Available options:
member
id
string
required
name
string
required
email
string
required
role
enum<string>
required
Available options:
admin,
member
seat
enum<string>
required

advisor or support. An advisor seat can be a client’s advisor; a support seat works with every client but cannot be anyone’s advisor.

Available options:
advisor,
support
phone
string | null
required

The phone the member set in their profile, filled into forms.

created_at
string
required

An ISO 8601 time in UTC.