Update an activation.
Update an activation. Address is mandatory if users company belongs to US.
Request
- Base URLhttps://api-qa2.enphaseenergy.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The Enlighten ID of the activation(system). System-generated.
Request body application/x-www-form-urlencoded
The name of the system. Limit 255 characters.
The type of the system. Possible values are 'residential', 'commercial', 'other'. Default 'residential'.
How the system's Envoys connect to the Internet. Possible values are none, cellular, broadband, dialup. Use 'dialup' if the Internet connection is satellite or dial-up
Whether the system is leased. Possible values true, false. Default false
Whether this system is permitted to operate. Possible values true, false. Default true
Enlighten ID of the system owner. Owner must be an Enlighten user. Optional. If the user of the API is a self-installer, the owner must be himself. If the user of the API is an installer then use the Search user API to get the owner user id. If the owner not exist in the enlighten then use Create home owner API to create it newly.
Enlighten ID of the system host. System host must be an Enlighten user. Optional. If the user of the API is an installer then use the Search user API to get the host user id. If the host not exist in the enlighten then use Create home owner API to create it newly. System host is applicable only in case of lease systems, i.e. lease should be true.
The Enlighten ID of the installer of this system. Defaults to current user's company ID
The Enlighten ID of the maintainer of this system. Defaults to current user's company ID
Enlighten ID of the sub-contractor you want to add to the system. Optional. If you are the home owner, you cannot add subcontractors for the site.
When true, the system will be eligible to appear in the public systems lists of Enphase and the system's installer. Default true
When the system was approved to connect to the grid. Epoch in seconds format
The source of production measurements taken on the system. Possible values 'meter', 'microinverters'. When 'meter', production values come from a revenue-grade meter on the system. When 'microinverters', production values come from the microinverters on the system.
The type of array installed. Possible values are fixed_open_rack, fixed_roof_mount, single_axis_tracking, single_axis_backtracking, dual_axis_tracking. All other values will be ignored. To unset array_type, pass null
How the microinverters are attached to the panels. Possible values are acm (AC Module), rack_mount (rack- or rail-mounted), zep (Zep Solar compatible), bipv (Building Integrated PV), frame_mount (Enphase Frame Mount), railless_mount (Other Railless Mount)
Specifies serial number of ensemble envoy in multi envoy system
The grid profile to set on this system's microinverters. See GridProfiles API for how to retrieve a list of known profiles.
The supported voltage/phase associated with a commercial system inside North America. If system type is not commercial, or if the installer exists & installer's country is not inside North America, or if the system's country is not inside North America, then the voltage value would be null
A list of Envoys installed on this system
Enlighten ID of the PV manufacturer associated with the PV model installed on the system. See PvManufacturers for how to retrieve PV manufacturer IDs
Name of the Custom PV Module Manufacturer associated with the system.
Enlighten ID of the PV model installed on the system. See PvManufacturers and PvModels for how to retrieve PV model IDs
Name of the Custom PV Module Model associated with the system.
Power Rating (in W) of the PV module installed on the system.
Type ID of the PV module installed on the system. 1 -> 'Mono-facial', 2 -> 'Bi-facial', 3 -> 'Split cell', 4 -> 'Other'
Total envoys the system is supposed to have
Total PCUs the system is supposed to have
Total nsrs the system is supposed to have
Total meters the system is supposed to have
Total encharges the system is supposed to have
Total enpowers the system is supposed to have
The identifier of this system as provided by the calling user's company. This attribute is not present if the calling user's company does not have a reference for this system. This value should be alphanumberic
This field is mandatory for sites in California, United States. Possible values for parameter: 1 – Net Billing Tariff (NEM 3.0), 2 – Net Metering, 3 – Net Feed-in tariff, 4 – Gross Feed-in tariff, 5 – Solar and/or Storage (with utility service), 6 – Full Off‑Grid (without utility service), 7 – Legacy: Net Metering Tariff, 8 – Legacy: Net Metering Tariff (with Hourly Dynamic Pricing), 9 – Smart Solar Billing, 10 – Smart Solar Billing (with Hourly Dynamic Pricing)
This field is mandatory for sites with battery in California, United States when grid_connection_type is 1. Battery grid mode must be either 1 (for Import Only) or 2 ( for Export Only).
This field is mandatory for sites in California, United States. Whether third party storage device is installed on the site.
This field is mandatory for sites in California, United States when the third_party_storage_device_installed field is passed as true. Manufacturer name of the third party storage device.
Date in epoch format
boolean (true / false)
Response
OK
The Enlighten ID of this system. System-generated
The name of the system.
The type of the system. One of 'residential', 'commercial', or 'other'. Default 'residential'. Cannot be null.
System's status.
What stage of the activation process this activation is in. System-generated.
How the system's Envoys connect to the Internet. Possible values are none, cellular, broadband, dialup. Use 'dialup' if the Internet connection is satellite or dial-up
Whether the system is leased. Possible values true, false. Default false
Whether this system is permitted to operate. Possible values true, false. Default true
The Enlighten ID of this system owner. System-generated. This field is optional.
The Enlighten ID of this system host. System-generated. This field is optional.
Name of the installer.
The Enlighten ID of the installer of this system. Defaults to current user's company ID
Name of the maintainer.
The Enlighten ID of the maintainer of this system. Defaults to current user's company ID
Battery grid mode can be of two types - Export Only, Import Only
If third party storage device is installed on the site.
Manufacturer name of the third party storage device.
Date in epoch format
boolean (true / false)
URI for this activation
Activation last updated timestamp
The identifier of this system as provided by the calling user's company. This attribute is not present if the calling user's company does not have a reference for this system.
The identifiers assigned to this activation by other companies which have access to it. This attribute is not present if there are no other references for this system.
When true, the system will be eligible to appear in the public systems lists of Enphase and the system's installer. Default true
When the system was approved to connect to the grid
Installer support email
The source of production measurements taken on the system. Possible values 'meter', 'microinverters'. When 'meter', production values come from a revenue-grade meter on the system. When 'microinverters', production values come from the microinverters on the system
The type of array installed. Possible values are fixed_open_rack, fixed_roof_mount, single_axis_tracking, single_axis_backtracking, dual_axis_tracking. All other values will be ignored. To unset array_type, pass null
How the microinverters are attached to the panels. Possible values are acm (AC Module), rack_mount (rack- or rail-mounted), zep (Zep Solar compatible), bipv (Building Integrated PV), frame_mount (Enphase Frame Mount), railless_mount (Other Railless Mount)
Specifies serial number of ensemble envoy in multi envoy system
Possible value is 'on' and 'off'
The grid profile to set on this system's microinverters. See GridProfiles API for how to retrieve a list of known profiles.
The supported voltage/phase associated with a commercial system inside North America. If system type is not commercial, or if the installer exists & installer's country is not inside North America, or if the system's country is not inside North America, then the voltage value would be null
A list of Envoys installed on this system
Total envoys the system is supposed to have
Total PCUs the system is supposed to have
Total nsrs the system is supposed to have
Total meters the system is supposed to have
Total encharges the system is supposed to have
Total enpowers the system is supposed to have
Enlighten ID of the PV manufacturer associated with the PV model installed on the system. See PvManufacturers for how to retrieve PV manufacturer IDs
Name of the Custom PV Module Manufacturer associated with the system.
Enlighten ID of the PV model installed on the system. See PvManufacturers and PvModels for how to retrieve PV model IDs
Name of the Custom PV Module Model associated with the system.
Power Rating (in W) of the PV module installed on the system.
Type ID of the PV module installed on the system. 1 -> 'Mono-facial', 2 -> 'Bi-facial', 3 -> 'Split cell', 4 -> 'Other'
Changes
No recorded changes to this operation across all 1 revision of this API.