Flip Energy API
  1. Schemas
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
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
      • Report Battery Counter Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  • Schemas
    • Schemas
      • Event
      • Command
      • Telemetry
      • Counter Telemetry
      • Utility
      • Tariff
      • EventStatus
      • Body_commission_site_and_device_v1_commission_post
      • Device
      • Device Copy
      • DeviceCreateIn
      • DeviceCreateCommissionIn
      • DeviceType
      • DeviceUpdateIn
      • DeviceBatteryConfig
      • DeviceBatteryAttributes
      • Enrollment
      • EnrollmentCreateIn
      • HTTPValidationError
      • EnrollMethodType
      • PeriodType
      • Program
      • Site
      • SortType
      • SpecsForBatteries
      • UserPreferencesForBatteries
      • ValidationError
      • VerificationStatus
      • Response
      • Response
      • WebhookEventType
      • Webhook - Command
      • Webhook - Event
      • Webhook - Enrollment
      • WebhookBody
      • BatteryMode
      • EventUpdate
      • EventBatterySettings
      • BatteryCommand
      • BatteryCommandUpdate
      • EventScheduleItem
      • CommandUpdate
      • Telemetry Device
      • Counter Telemetry Device
      • BatteryPowerMode
  1. Schemas

CommissionBody(Body_commission_site_and_device_v1_commission_post)

{
    "site": {
        "id": "abc-789",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "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"
    },
    "devices": [
        {
            "id": "xyz-123",
            "site_id": "abc-789",
            "manufacturer_name": "DeviceMaker",
            "product_name": "Model 1",
            "serial_number": "123456789",
            "type": "BATTERY",
            "attributes": {
                "battery_capacity_wh": 15000,
                "battery_power_input_w": 6000,
                "battery_power_output_w": 7500
            },
            "install_date": "2025-06-19T15:30:00-07:00",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "can_auto_enroll": true,
    "enrollment": {
        "device_ids": [
            "xyz-123"
        ],
        "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
        "enroll_method": "AUTO_ENROLL",
        "has_agreed_to_terms_and_conditions": true,
        "terms_and_conditions_version": "2025-01-01",
        "program_specific_attributes": [
            {
                "name": "account_id",
                "value": "1234567-0"
            }
        ]
    }
}
Built with