ENenphase
Companies

Create company user

Create a company user. When the user is created in the context of a company, then the user is belongs to that company. Otherwise, the user does not belong to a company. Email, First Name, and Last Name are mandatory fields in the user. Any unneeded fields passed in the request parameter will be skipped and not stored. Pass body param in 'application/x-www-form-urlencoded' format, in this endpoint, key will be 'user' and value will be a JSON dictionary of user fields.

post/api/v4/companies/{company_id}/users

Request

Path parameters

company_idinteger required

Company ID

Request body application/x-www-form-urlencoded

emailstring required

The email address of the user. Must be unique within Enlighten. Required

enlighten_emailsboolean

Whether the user receives automated emails from Enlighten. Default false.

first_namestring required

The user's first name. Required

last_namestring required

The user's last name. Required

phonestring

The telephone number of the user. Optional. Max length 50.

Response

Created

activeboolean

Whether the user is allowed to log in to Enlighten.

user_rolesstring[]

What type of user this is in Enlighten. Possible values are ['self_installer']. For self installer user user_roles will be ['self_installer']. For other users user_roles will be empty.

emailstring

The email address of the user

enlighten_emailsboolean

Whether the user receives automated emails from Enlighten

enlighten_viewstring

Which view of Enlighten the user has

first_namestring

The user's first name

last_namestring

The user's last name

phonestring

The telephone number of the user.

uristring

URI to the show() method for the user. System-generated.

user_idinteger

The Enlighten ID of the user. System-generated.

updated_atinteger

Last updated date and time in Epoch format.

Changes

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