Create Enrollment - Flip Energy API

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

device_ids

array[string]

required

A list of devices to enroll

program_id

string <uuid>

Program ID

required

ID of the program to enroll in

enroll_method

enum<string>

required

Allowed values:

AUTO_ENROLLUSER_ACTION

has_agreed_to_terms_and_conditions

boolean | null

optional

terms_and_conditions_version

string | null

optional

Example:

2025-01-01

program_specific_attributes

array [object {2}]

optional

name

string

required

Example:

account_id

value

string

required

Example:

1234567-0

Example

{
    "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"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mock.apidog.com/m1/479670-0-default/v1/site//enrollments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

id

string <uuid>

Id

required

device_ids

array[string]

required

site_id

string

required

Example:

abc-123

program_id

string <uuid>

Program Id

required

enroll_method

enum<string>

required

Allowed values:

AUTO_ENROLLUSER_ACTION

status

enum<string>

required

Allowed values:

ACTIVENEEDS_ACTIONPENDINGREJECTEDUNENROLLED

status_reason

string | null

read-onlyrequired

Example:

Enrollment approved by utility

enrolled_at

string <date-time> | null

Enrolled At

read-onlyrequired

unenrolled_at

string <date-time> | null

Unenrolled At

read-onlyrequired

program_specific_attributes

array [object {2}]

required

name

string

required

Example:

account_id

value

string

required

Example:

123456-0

has_agreed_to_terms_and_conditions

boolean | null

required

terms_and_conditions_version

string | null

required

Example:

2025-01-01

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "device_ids": [
        "xyz-123"
    ],
    "site_id": "abc-123",
    "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
    "enroll_method": "AUTO_ENROLL",
    "status": "ACTIVE",
    "status_reason": "Enrollment approved by utility",
    "enrolled_at": "2019-08-24T14:15:22Z",
    "unenrolled_at": "2019-08-24T14:15:22Z",
    "program_specific_attributes": [
        {
            "name": "account_id",
            "value": "123456-0"
        }
    ],
    "has_agreed_to_terms_and_conditions": true,
    "terms_and_conditions_version": "2025-01-01"
}

🟠400Invalid input

🟠404Record not found

🟠409Conflict

🟠422Missing information