Update a User

Body Params
string
required

This is the Enerflo user ID for the user you are updating

string

This optional field represents the email address of the Enerflo user who will be assigned as the manager for the user being updated.

string
string
string

A 10-digit phone number can be provided in various formats, including with or without formatting. All of the following examples are valid:555-555-5555, 5555555555, and (555) 555-5555.

string

Each user must have a unique email address.

boolean
roles
array of strings

Use the 'Role Name' when assigning a role to a new user — not the 'Role Slug.' 'Role Slugs' are internal identifiers, while 'Role Names' are the correct values for role assignment. Multiple roles can be assigned. Refer to the following list of 'Role Names': https://docs.enerflo.io/docs/legend-of-user-roles

Updating a user by removing a role without first reassigning attributed surveys or appointments (e.g. sales rep or setter) will fail. Best practice is to reassign these leads and deals first via https://docs.enerflo.io/reference/update-the-details-of-a-customer

When removing project manager roles, ensure they are also removed as project contacts for any associated installs. Use https://docs.enerflo.io/reference/delete-a-contact-from-an-install or follow the recipe https://docs.enerflo.io/recipes/delete-project-contacts-using-customer-id

roles
office_ids
array of int32s

An array of office IDs used to assign the user's office(s). The office_ids field accepts an array of IDs and applies them as follows:

1. First Office ID: The first ID in the array is applied to all the user's roles (including regional manager).
2. Additional IDs: Any additional IDs in the array are assigned only to the regional manager role. If the user does not have the regional manager role, these additional IDs will be ignored.

To retrieve your office_ids value(s), click here: https://docs.enerflo.io/docs/retrieving-the-office-id

office_ids
Responses

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