PUT
Edit an organization member
Organization space User accounts only For: Administrator · Permission: organization_members.update Conditions
  • pseudo, when sent, is trimmed and must not be empty, at most 250 characters, and unique in the organization, ignoring case and surrounding spaces, among the other members and the pending unexpired invitations; a concurrent clash is also reported as a pseudo error.
  • Deactivating (is_active false) is refused with 403 for the organization owner and for the caller’s own membership. Sending is_active true is not restricted by this rule.
What else happens
  • When the member is deactivated, the member’s profile assignments in the organization 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

member
string
required

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

Body

application/json
pseudo
string | null

New display name, trimmed, at most 250 characters, unique in the organization among members and pending invitations, ignoring case. Optional, but when the key is sent it cannot be empty or null.

Maximum string length: 250
is_active
boolean

Whether the member is active. Optional; false is refused (403) for the organization owner and for the caller's own membership.

Response

OrganizationMemberResource

organization_id

Identifier of the organization the record belongs to.

id

Identifier of the organization 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).