Skip to main content
POST
End programme

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Body

application/json
requestId
string
required
expectedRevision
required
reason
string
required

Response

Success

id
string
required
reference
string
required
name
string
required
status
enum<string>
required
Available options:
active,
ended
templateId
string
required
templateName
string
required
serviceCategory
string
required
assetClass
string
required
eventType
string
required
statutory
boolean
required
instructions
string
required
propertyId
string | null
required
propertyLabel
string | null
required
blockId
string | null
required
blockLabel
string | null
required
assetId
string | null
required
assetLabel
string | null
required
complianceKind
enum<string> | null
required
Available options:
gas_safety,
eicr,
epc,
smoke_co
recurrenceInterval
required
recurrenceUnit
enum<string>
required
Available options:
day,
week,
month,
quarter,
year
anchorDay
required
instructionLeadDays
required
nextDueOn
string | null
required
overdue
boolean
required
jobCategory
string | null
required
contractorContactId
string | null
required
contractorName
string | null
required
autoInstruct
boolean
required
autoInstructSetAt
string | null
required
responsibleTeamId
string | null
required
responsibleTeamName
string | null
required
managerStaffId
string | null
required
managerName
string | null
required
costCodeId
string | null
required
costCodeLabel
string | null
required
notes
string | null
required
liveEventId
string | null
required
liveEventStatus
enum<string> | null
required
Available options:
due,
instructed,
booked,
completed,
cancelled
liveEventReviewState
enum<string> | null
required
Available options:
pending,
accepted,
rejected
endedAt
string | null
required
endReason
string | null
required
revision
required
createdByUserId
string | null
required
createdAt
string
required
updatedAt
string
required
events
object[]
required