Edit partner user

Update an existing partner user's name/title, role, account assignments, optional password and deactivation date. Password changes and deactivations revoke the target's live tokens (SOC 2 CC6.2) and are audited. The target must belong to the caller's company.

Auth

  • Partner — collection bearer token. In-controller gate: the target's company_id must equal the caller's, else 403 Permission denied.

Rate limit

  • No rate limit.

Body

FieldTypeRequiredNotes
userintegerRequiredId of the user to edit.
user_typestringRequiredadmin, assign_brand, or basic.
first_namestringRequired≤255 chars; no angle brackets.
last_namestringOptional≤255 chars.
titlestringOptional≤50 chars.
passwordstringOptional8–100 chars, complexity rules; blank leaves the password unchanged. Changing it revokes the user's tokens.
accountinteger[]Required if user_type=assign_brand, or basic with assign_all_accounts=0Account company ids under the caller.
assign_all_accountsintegerRequired if user_type=basic0/1.
send_default_reportsintegerOptional0/1.
inactive_atstringOptionalY-m-d H:i:s; setting a past/imminent date deactivates the user and revokes their tokens.

Behaviour

  • Synchronous (DB transaction). 200 on success.
  • 403 when the target is not in the caller's company (Permission denied.).
  • 422 on validation failure; 500 on save failure.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
string
string
string | null
account
array of integers
account
integer
integer
string | null
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json