ENenphase
Users

Update user

You must have access to the requested activation and user; otherwise a 401 is returned. The user is requested in the scope of an activation, then it must be the owner or the host of an activation the API user can manage (or) Users created by API user (or) Users who belong to your company or its branches. When 'company_id' is passed in the body param or the user company_id is already defined, we will not consider the 'enlighten_view' field value and the user will become an enlighten manager. You may change a user's company if you have access to the user, the old company, and the new company.

put/api/v4/activations/{activation_id}/users/{user_id}

Request

Path parameters

activation_idinteger required

The Enlighten ID of the activation(system). System-generated.

user_idinteger required

The Enlighten ID of the user. System-generated.

Request body application/x-www-form-urlencoded

company_idinteger

The Enlighten-generated ID of the company to which the user belongs, if any. DEPRECATED: Use the 'company' attribute instead, and the query parameter 'expand=company' to get detailed company information.

emailstring

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

first_namestring

The user's first name. Required.

last_namestring

The user's last name. Required.

phonestring

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

Response

OK

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.