Skip to main content
POST
Approve an enrollment request

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

enrollment_id
string
required

Flatpeak VPP Enrollment ID.

Response

Enrollment response.

A device's membership of a VPP program. When the program has enrollment.approval_required, requests wait for your decision at AWAITING_APPROVAL. Changes fire vpp_enrollment.update.

id
string
required

Flatpeak VPP Enrollment ID.

Example:

"enr_7c2f1a9e4b0d8f3a6e2c5d10"

object
enum<string>
required

Object type, vpp_enrollment.

Available options:
vpp_enrollment
Example:

"vpp_enrollment"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

program_id
string
required

Program the enrollment belongs to.

Example:

"vpr_5c8d1f2a7b3e4d6c9a0f1b2c"

oem_id
string
required

Flatpeak OEM ID: the OEM that connects the enrolled device.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

enrollment_state
enum<string>
required

The enrollment lifecycle state. enrollment_step gives the detail.

Available options:
PENDING,
ACTIVE,
SUSPENDED,
LEAVING,
ENDED,
REJECTED
Example:

"ACTIVE"

enrollment_step
enum<string>
required

The step within enrollment_state.

Available options:
REQUESTED,
AWAITING_CONSENT,
AWAITING_TARIFF,
AWAITING_TELEMETRY,
TESTING_DISPATCH,
AWAITING_APPROVAL,
ACTIVE,
SUSPENDED,
UNENROLLING,
UNENROLLED,
INELIGIBLE,
FAILED
Example:

"ACTIVE"

suspension_reasons
enum<string>[]
required

Why the enrollment is suspended: an empty list unless enrollment_state is SUSPENDED.

Available options:
DISPATCH_UNRESPONSIVE,
CONSENT_REVOKED,
TELEMETRY_STALLED,
USER_PAUSED
terms
object
required
read-only

The program's terms as they stood when the customer joined. Rewards are priced from this copy, and a later change to the program's terms does not alter it.

time_enrolled
string<date-time> | null
required

Time when the enrollment went ACTIVE, in UTC. null until then.

Example:

"2026-01-24T14:15:22Z"

time_unenrolled
string<date-time> | null
required

Time the enrollment reached UNENROLLED, in UTC. null while the enrollment has not ended.

Example:

"2026-08-01T09:12:44Z"

time_created
string<date-time>
required

Time the enrollment was created, in UTC.

Example:

"2026-01-20T09:30:00Z"

time_updated
string<date-time>
required

Time the enrollment was last updated, in UTC.

Example:

"2026-08-12T09:30:00Z"