Skip to main content
POST
/
vpp-participations
Create a VPP participation
curl --request POST \
  --url https://api.flatpeak.com/vpp-participations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "AZ01346701301",
  "provider_id": "prv_8587fa49c7e5297ccc6c57e5",
  "programme_id": "vpr_6a1f8e375db9de605baadd46",
  "device_id": "dev_63a6087272941ef077a8fd3e"
}
'
{
  "id": "vpp_7c2f1a9e4b0d8f3a6e2c5d10",
  "reference_id": "AZ01346701301",
  "object": "vpp-participation",
  "live_mode": true,
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "control_active": true,
  "telemetry_active": true,
  "suspension_reasons": [],
  "participation_state": [
    {
      "state": "ACTIVE",
      "status": "COMPLETE",
      "description": "Your device is dispatching.",
      "occurred_at": "2023-11-07T05:31:56Z",
      "expected_at": "2023-11-07T05:30:02Z",
      "time_created": "2023-11-07T05:30:02Z",
      "suspension_reasons": [],
      "metadata": "Device properties changed, registration update successful. Reference XM2345TYUQ."
    }
  ],
  "time_updated": "2023-11-07T05:31:56Z",
  "time_created": "2023-11-07T05:31:56Z",
  "provider": {
    "id": "prv_8587fa49c7e5297ccc6c57e5",
    "display_name": "Leap",
    "logo_url": "https://s.flatpeak.com/83b06a60e38c2.png",
    "support_email": "help@leap.com"
  },
  "programme": {
    "id": "vpr_6a1f8e375db9de605baadd46",
    "display_name": "Community Powershare",
    "learn_more_url": "https://leap.com/programmes/community-powershare"
  },
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Body

application/json

Create a device's participation in a VPP programme.

​
reference_id
string
required

Programme provider reference ID for this participation.

Example:

"AZ01346701301"

​
provider_id
string
required

Programme provider reference ID for this participation.

Example:

"prv_8587fa49c7e5297ccc6c57e5"

​
programme_id
string
required

Programme provider reference ID for this participation.

Example:

"vpr_6a1f8e375db9de605baadd46"

​
device_id
string
required

Identifier of the enrolled device.

Example:

"dev_63a6087272941ef077a8fd3e"

​
participation_state
object

Response

Example response

A device's participation in a VPP programme, including the lifecycle timeline of states it has passed through, is in, and is expected to reach.

​
id
string
required

Unique identifier for the VPP participation.

Example:

"vpp_7c2f1a9e4b0d8f3a6e2c5d10"

​
reference_id
string
required

Programme provider reference ID for this participation.

Example:

"AZ01346701301"

​
object
string
required

String representing the object type. Always vpp-participation.

Example:

"vpp-participation"

​
live_mode
boolean
required

Whether the enrolment exists in live mode.

​
device_id
string
required

Identifier of the enrolled device.

Example:

"dev_63a6087272941ef077a8fd3e"

​
location_id
string
required

Identifier of the location the device belongs to.

Example:

"loc_641b90b758fb8e6293716e40"

​
current_state
enum<string>
required

The state the enrolment is currently in. Matches the single enrolment_state entry whose status is IN_PROGRESS.

Available options:
ENROLMENT_REQUESTED,
AWAITING_CUSTOMER_CONSENT,
AWAITING_DEVICE_TELEMETRY,
AWAITING_LOCATION_TELEMETRY,
CHECKING_ELIGIBILITY,
AWAITING_REGISTRATION,
REGISTERED,
INELIGIBLE,
ACTIVE,
SUSPENDED,
UNENROLMENT_REQUESTED,
WINDING_DOWN,
UNENROLLED,
OFFBOARDED,
FAILED
​
control_active
boolean
required

Set to true when the device can currently be dispatched. True only when current_state is ACTIVE.

​
telemetry_active
boolean
required

Set to flase when device telemetry is missing for more than 24 hours.

​
suspension_reasons
enum<string>[]
required

Active suspension reasons while current_state is SUSPENDED. Empty otherwise.

Available options:
AWAITING_TELEMETRY,
AWAITING_DISPATCH,
AWAITING_CONSENT,
OPERATOR_REQUEST,
CUSTOMER_REQUEST
​
participation_state
object[]
required

Ordered lifecycle timeline. Past states are COMPLETE, the current state is IN_PROGRESS, and expected future states are PENDING. Render in array order, do not sort by date.

Minimum array length: 1
​
time_updated
string<date-time>
required

Time the enrolment was last updated.

​
time_created
string<date-time>
required

Time the enrolment was created.

​
provider
object

Provider information

​
programme
object
​
account_id
string

Flatpeak Account ID.

Example:

"acc_661677911f2197045e6cf1b1"