ENenphase
Home Owner

Create Home owner

Create a home owner user. 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. Using this API to create both homeowner as well as a company user. If you want to create company user, then pass company_id inside the user object.

post/api/v4/users

Request

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.

enlighten_viewstring

Which view of Enlighten the user has. Options 'my' for MyEnlighten, 'manager' for Enlighten Manager. Default 'my'. Users who do not belong to companies should be set to 'my'. You must have an agreement with Enphase Energy to set a user to 'manager'. Company id is required when enlighten_view is 'manager'

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 255.

company_idinteger

The Enlighten-generated ID of the company to which the user belongs, if any.

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.