Skip to main content
POST
Plan job

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Body

application/json
requestId
string
required
source
enum<string>
required
Available options:
programme
worksProgrammeId
string
required
propertyId
string
required
kind
enum<string> | null
Available options:
works,
logistics
title
string · null · null
scheduledOn
string · null · null
startMinute
endMinute
quoteMinor

Response

Success

key
string
required
source
enum<string>
required
Available options:
cycle,
programme
id
string
required
title
string
required
propertyId
string | null
required
blockId
string | null
required
addressLine
string | null
required
area
string | null
required
sourceLabel
string
required
cycleId
string | null
required
programmeId
string
required
contractorContactId
string | null
required
contractorName
string | null
required
dueOn
string
required
overdue
boolean
required
estCostMinor
required
status
enum<string>
required
Available options:
assign,
not_booked,
awaiting_approval,
access_refused,
tenant_notified,
booked,
done
approvalState
enum<string> | null
required
Available options:
required,
sent,
approved,
declined
tenantNotifiedAt
string | null
required
accessRefusedAt
string | null
required
accessRefusedReason
string | null
required
skippable
boolean
required
booking
object | null
required
budgetLineId
string | null
required
revision
required