Skip to content

Ramp: Update a user — request body — body

Update a user: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Update a user — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
auto_promotebooleanOptionalWhether to automatically promote the users manager to manager.
department_idstringOptionalUnique identifier of the employee’s department
Format: uuid
direct_manager_idJSONOptional
direct_manager_id (anyOf 1)stringAlternativeUnique identifier of the employee’s direct manager
Format: uuid
direct_manager_id (anyOf 2)nullAlternative
first_namestringOptionalMinimum length: 1
is_managerbooleanOptionalWhether the employee is a manager
last_namestringOptionalMinimum length: 1
location_idstringOptionalUnique identifier of the employee’s location
Format: uuid
rolestringOptionalThe employee’s role; It could be one of the following values: Admin, Cardholder, Bookkeeper; Note that Owner is not a permissible value.
One of: AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, GUEST_USER, IT_ADMIN
scheduled_deactivation_dateJSONOptional
scheduled_deactivation_date (anyOf 1)stringAlternativeThe date when the user is scheduled to be deactivated. Set to null to clear. Cannot be set for admins or owners.
Format: date
scheduled_deactivation_date (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.