Docs

Update Member

Move a member to another role.

PUT

Path

Path parameters
stringrequired

The member's userId, from List Members.

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
stringrequired

The role to give them, from List Roles.

Response fields

userIdstring

Unique id of the member.

namestring

The member's name.

emailstring

The member's email address.

isPendingboolean

True while their invite is waiting to be accepted.

roleIdstring

The role they hold.

roleNamestring

That role's name.

createdOndate

When they joined the company.