Skip to main content
PUT
Move a task of the Setup
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

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

Path Parameters

key
string
required

Body

application/json
status
enum<string>
required

DONE marks it done, SKIPPED skips it, TODO restores it, IN_PROGRESS starts it

Available options:
TODO,
IN_PROGRESS,
DONE,
SKIPPED
item
string | null

Which item of a task repeated per item, as getCompanySetup gives it (e.g. payfit, apple_business); null for a task that is not repeated

Minimum string length: 1

Response

default - application/json
started
boolean
required

False when the company has no Setup to show: no onboarding yet, or one still a draft

completedAt
string<date-time> | null
required

When the Setup ended; null while a task is open

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
upNext
object[]
required

The tasks the Setup page shows first, in order

sections
object[]
required

Every task, by product, in the order of the Setup page

facts
object
required

What Primo knows of the company's stack: devices, currentMdm, hris, emailProviders, chat, edr, buysDevices, admins