PUT
Update a member
Company space User accounts only For: Administrator · Permission: members.update Conditions
  • pseudo, when sent, must be at most 250 characters and unique in the company, ignoring case and surrounding spaces, among the other members and the pending unexpired invitations; this member’s own pseudo is ignored.
  • The company owner cannot be deactivated by someone else: the call is refused with 403 when is_active is false for the owner.
  • A caller editing their own membership cannot change their own active state: is_active is silently ignored, only pseudo changes.
What else happens
  • When the member is deactivated, the member’s profile assignments in the company are retired: public accounting export links they created are revoked and stay revoked after reactivation. The assignments themselves are not deleted.
Part of Manage members.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

memberId
string
required

Identifier of the member, meaning the membership record of the person in the company or client space, not the user identifier (27-character KSUID string).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, user_id, pseudo, phone_number, email, is_active, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
is_active
boolean

Whether the member is active. Optional; when omitted the state is kept. Ignored when the caller edits their own membership, and refused (403) when it would deactivate the owner.

pseudo
string

New display name, at most 250 characters, unique in the company or client among members and pending invitations, ignoring case and surrounding spaces. Optional; when omitted the pseudo is kept.

Maximum string length: 250

Response

Resource (only with response=resource).

id

Identifier of the membership record (27-character KSUID string); this is what the {member} path parameters expect.

user_id

Identifier of the user account behind the member (27-character KSUID string).

pseudo

Display name of the member in this space; unique within it, ignoring case. May be null when none was set.

phone_number

Phone number of the underlying account; null when the account has none.

email

Email address of the underlying account; null when the account has none.

is_active
boolean

Whether the member can act in this space. Deactivated members keep their record.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).