Flip Energy API
  1. Commands
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
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
        PATCH
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Commands

Update Command Status

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
PATCH
/v1/command/{id}
Use this endpoint to acknowledge commands. If it was properly received set device_status to OK, otherwise set it to FAILED.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Body Params application/json

Example
{
    "device_status": "FAILED_OFFLINE",
    "device_status_reason": "Command scheduled"
}

Request Code 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/command/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_status": "FAILED_OFFLINE",
    "device_status_reason": "Command scheduled"
}'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
    "device_id": "xyz-123",
    "starts_at": "2025-04-30 12:00:00.000Z",
    "ends_at": "2025-04-30 14:00:00.000Z",
    "duration_s": 7200,
    "is_preparatory_action": true,
    "battery_commands": {
        "mode": "BACKUP",
        "power_mode": "FOLLOW_LOAD",
        "setpoint_w": 5000,
        "enable_grid_import": true,
        "enable_grid_export": true,
        "backup_reserve_percentage": 20,
        "maximum_charge_percentage": 90
    },
    "status": "CANCELED",
    "device_status": "FAILED_OFFLINE",
    "device_status_reason": "Command scheduled",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}
🟠400Invalid input
🟠404Record not found
Modified at 2025-07-23 10:37:35
Previous
Command Created
Next
Read Programs
Built with