Add a User

string

required

This is the email address the new user will supply as their login to Enerflo.

roles

array of strings

required

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

roles*

notify_email

boolean

required

Defaults to false

If true, the new user will receive a welcome email.

can_create_customers

boolean

Defaults to true

Controls if the new user will be allowed to create new customers or leads in Enerflo.

allow_optimus

boolean

required

Defaults to false

Controls if the new user will be allowed to access Optimus (Enerflo's proposal tool).

first_name

string

The first name of the new user.

last_name

string

The last name of the new user.

phone

string

The phone numberof the new user.

password

string

Optional. If left blank the new user will be able to select their own password.

timezone

string

enum

The home timezone of the new user.

external_user_id

string

This field is optional. It allows you to provide an external ID that will be linked to the new user. A typical scenario involves using this field to store the user's ID as recognized by an external Customer Relationship Management (CRM) system.

manager_email

string

Manager email can only be set on the Sales Rep role. This optional field represents the email address of the Enerflo user who will be assigned as the manager for the user being created.

manager_id

int32

Manager ID can only be set on the Sales Rep role. If both ID and email are present, the manager_id field is used instead of the manager_email field.

office_id

string

Office ID can only be set on the Sales Rep role. To retrieve your office_id value(s), click here: https://docs.enerflo.io/docs/retrieving-the-office-id

can_reassign_leads

boolean

This field is true by default. It allows users with the appropriate roles to reassign setters and sales reps on leads.

200200

400400