users

Users:Patch User

patch/api/v1/users/{id}

Request

  • Base URL: https://api.peil.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.peil.app/api/v1/users/{id}
  • Auth: OAuth 2 (password, token URL /api/v1/auth/jwt/login)

Path parameters

idstring required

Request body

passwordstring nullable
emailstring email nullable
is_activeboolean nullable
is_superuserboolean nullable
is_verifiedboolean nullable
full_namestring nullable
business_namestring nullable
langstring nullable
business_start_datestring date nullable
vat_numberstring nullable
chamber_of_commercestring nullable
address_line1string nullable
address_line2string nullable
citystring nullable
postal_codestring nullable
countrystring nullable
ibanstring nullable
iban_account_namestring nullable
default_currencystring nullable
timezonestring nullable
phone_numberstring nullable
marketing_opt_outboolean nullable

Response

Successful Response

idinteger required
emailstring email required
is_activeboolean
is_superuserboolean
is_verifiedboolean
full_namestring nullable
business_namestring nullable
business_start_datestring date nullable
vat_numberstring nullable
chamber_of_commercestring nullable
address_line1string nullable
address_line2string nullable
citystring nullable
postal_codestring nullable
countrystring nullable
ibanstring nullable
iban_account_namestring nullable
default_currencystring nullable
timezonestring nullable
phone_numberstring nullable
onboarding_completeboolean
langstring nullable
workspace_slugstring nullable
planstring
marketing_opt_outboolean
is_adminboolean required

Whether this user has Captain's-deck access — the SAME rule the backend enforces (is_superuser OR the ADMIN_USER_IDS allowlist), so the nav link matches reality. Gating the link on is_superuser alone hid the deck from an allowlisted admin who isn't a DB superuser. Reuses admin._admin_user_ids (SSOT); imported lazily to avoid a router↔schema import cycle.

Changes

No recorded changes to this operation across all 1 revision of this API.