Skip to main content
POST
Execute the equipment step of an onboarding
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

onboardingId
string
required

Body

application/json
order
object

Catalog order to place. Omit when nothing is purchased.

assignedFromInventory
object

Devices and accessories taken from existing stock and assigned to the employee.

automaticEnrollment
boolean

Leave unset to keep the onboarding current setting.

sendToPersonalEmail
boolean

Leave unset to keep the onboarding current setting.

Response

default - application/json
onboarding
object
required
order
object | null

The order that was placed, or null when the step was executed without a purchase.