PUT
Update my account details
Any signed-in account User accounts only For: Everyone Conditions
  • Requires a signed-in member (user, client or organization account); no permission is involved.
  • You can only edit your own account.
  • first_name and last_name, when sent, must be 3 to 250 characters; phone_number, when sent, 3 to 30 characters.
  • phone_number must not be used by another account (unique across all accounts, the member’s own number is ignored).
  • Sending null or omitting a field keeps the current value: a field cannot be cleared.
  • Email, password and activity cannot be changed here.
Part of Your account and notifications.

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

Identifier of the user (27-character KSUID). Must be the signed-in user's own id.

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, first_name, last_name, email, phone_number, type, is_active, email_verified_at, created_at, updated_at, current_user_profile_id.

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: userProfiles, userProfiles.profile, userProfiles.company, userProfiles.client, userProfiles.organization.

Body

application/json
first_name
string | null

First name, 3 to 250 characters. Optional: null or omitted keeps the current value.

Required string length: 3 - 250
last_name
string | null

Last name, 3 to 250 characters. Optional: null or omitted keeps the current value.

Required string length: 3 - 250
phone_number
string | null

Phone number, 3 to 30 characters, unique across accounts (your own number is ignored). Optional: null or omitted keeps the current value.

Required string length: 3 - 30

Response

Resource (only with response=resource).

id

Identifier of the member (27-character KSUID).

first_name

First name of the member.

last_name

Last name of the member.

email

Email address of the member, used to sign in; it cannot be changed through the update call.

phone_number

Phone number of the member, unique across accounts.

type

Account type of the session, taken from the token: user, client or organization.

is_active
boolean

Whether the member may sign in.

email_verified_at

When the email was verified, ISO 8601; null when not verified.

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).

current_user_profile_id

Identifier of the profile assignment the session acts under, from the token; null when none is selected.

user_profiles
array

Active profile assignments of the user usable in the session's space. Present only when the include userProfiles is requested.