Users

Update an existing user (profile / budget / status / email-aliases / identities)

Changed on
patch/api/users/{id}

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/users/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring
emailstring email nullable
rolestring
notesstring
emailAliasesstring[]
preferredChannelstring
timezonestring
metadataobject nullable
dailyBudgetUsdnumber nullable
status'invited' | 'active' | 'suspended'

Response

User updated

Changes

    • breaking

      the request property type changed from string to string null, and format from no format to email

    • info

      the request property became nullable

    • info

      added the new optional request property