Flip Energy API
  1. Sites
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Change log
  • Mobile App API
    • Devices
      • Create Device
      • Read Devices
      • Read Device
      • Update Device
      • Delete Device
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
      • Read Event
      • Update Event Participation
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
        GET
      • Update Site
        PATCH
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Sites

Update Site

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
PATCH
/v1/site/{siteId}
sites

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
siteId
string 
required
Body Params application/json
first_name
string  | null 
optional
Example:
John
last_name
string  | null 
optional
Example:
Doe
company_name
string  | null 
optional
Ony if the customer is a company
Example:
ABC Co.
email
string <email> | null 
optional
state_code
enum<string>  | enum<null> 
State code
optional
Two-character code representing a US state or territory.
Allowed values:
AKALARAZCACOCTDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVTWAWIWVWY
city
string  | null 
City
optional
Example:
San Francisco
zip_code
string  | null 
Zip Code
optional
In the sandbox, use zip codes 88800, 88801 or 88802 to match with test programs.
Examples:
888008880188802
street_address
string  | null 
Street Address
optional
Example:
123 Main St
street_address2
string  | null 
Street Address2
optional
service_account_id
string  | null 
Service Account Id
deprecated
An ID assigned to the residential customer by the utility. Can typically be found on the utility bill.
Example:
deprecated
Example
{
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "ABC Co.",
    "email": "[email protected]",
    "state_code": "AK",
    "city": "San Francisco",
    "zip_code": "88800",
    "street_address": "123 Main St",
    "street_address2": "string",
    "service_account_id": "deprecated"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://mock.apidog.com/m1/479670-0-default/v1/site/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "ABC Co.",
    "email": "[email protected]",
    "state_code": "AK",
    "city": "San Francisco",
    "zip_code": "88800",
    "street_address": "123 Main St",
    "street_address2": "string",
    "service_account_id": "deprecated"
}'

Responses

🟢200OK
application/json
Body
first_name
string  | null 
optional
Example:
John
last_name
string  | null 
optional
Example:
Doe
company_name
string  | null 
optional
Ony if the customer is a company
Example:
ABC Co.
email
string <email> | null 
optional
state_code
enum<string>  | enum<null> 
State code
optional
Two-character code representing a US state or territory.
Allowed values:
AKALARAZCACOCTDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVTWAWIWVWY
city
string  | null 
City
optional
Example:
San Francisco
zip_code
string  | null 
Zip Code
optional
In the sandbox, use zip codes 88800, 88801 or 88802 to match with test programs.
Examples:
888008880188802
street_address
string  | null 
Street Address
optional
Example:
123 Main St
street_address2
string  | null 
Street Address2
optional
service_account_id
string  | null 
Service Account Id
deprecated
An ID assigned to the residential customer by the utility. Can typically be found on the utility bill.
Example:
deprecated
Example
{
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "ABC Co.",
    "email": "[email protected]",
    "state_code": "AK",
    "city": "San Francisco",
    "zip_code": "88800",
    "street_address": "123 Main St",
    "street_address2": "string",
    "service_account_id": "deprecated"
}
🟠400Invalid input
🟠404Record not found
Previous
Read Site
Next
Get Site Token
Built with