Skip to main content
PATCH
Update a user (name, status, role, branch)

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Path Parameters

id
string<uuid>
required

Body

application/json
full_name
string
status
enum<string>

Reactivation goes through the seat check; the last active Company_Admin cannot be deactivated.

Available options:
active,
inactive
role
string
role_id
string<uuid>
branch_id
string<uuid> | null

Response

User updated

success
enum<boolean>
Available options:
true
data
object
meta
object