SOsoraban
Clients

Update a client

Updates contact details, and optionally reassigns the advisor.

Changing email also moves the underlying login identity, so the client signs in with the new address immediately. Set notify_old_email to tell the previous address that the change happened.

patch/clients/{id}

Request

Request body

fnamestring
lnamestring
emailstring email

Changing this also moves the client's login identity.

phone_numberstring
work_phone_numberstring
work_phone_extensionstring
preferred_contact_methodstring
time_zonestring
external_user_idstring
assigned_advisor_idinteger

Reassigns the advisor. Rejected for firms on the newer contact management model.

notify_old_emailboolean

Tell the previous address that the email changed.

accessstring

Firm access level for this user.

Response

The updated client.

idinteger
emailstring nullable
fnamestring nullable
lnamestring nullable
full_namestring nullable
time_zonestring nullable
phone_numberstring nullable
preferred_namestring nullable
created_atstring date-time
last_activity_atstring date-time nullable
preferred_sign_in_methodstring nullable
activeboolean nullable

False for a client marked inactive.

work_phone_numberstring nullable
work_phone_extensionstring nullable
work_emailstring nullable
external_user_idstring nullable
assigned_advisor_idinteger nullable

Only present for firms on the older contact management model.

assigned_advisorstring nullable

Only present for firms on the older contact management model.

Changes

No recorded changes to this operation across all 2 revisions of this API.