Skip to main content
PATCH
Update event

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
dueOn
string | null
instructionNotes
string · null · null

Response

Success

id
string
required
programmeId
string
required
programmeReference
string
required
programmeName
string
required
occurrence
required
reference
string
required
status
enum<string>
required
Available options:
due,
instructed,
booked,
completed,
cancelled
reviewState
enum<string> | null
required
Available options:
pending,
accepted,
rejected
dueOn
string
required
instructBy
string
required
overdue
boolean
required
revisit
boolean
required
statutory
boolean
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
contractorContactId
string | null
required
contractorName
string | null
required
instructedAt
string | null
required
instructionNotes
string | null
required
instructedAutomatically
boolean
required
autoInstructSkippedReason
string | null
required
booking
object | null
required
completedOn
string | null
required
completedAt
string | null
required
completedByUserId
string | null
required
completionNotes
string | null
required
reviewedAt
string | null
required
reviewedByUserId
string | null
required
reviewNotes
string | null
required
rejectionReason
string | null
required
remedialRepair
object | null
required
nextEventId
string | null
required
certificateDocumentId
string | null
required
costCodeId
string | null
required
cancelledAt
string | null
required
cancelReason
string | null
required
evidenceCount
required
revision
required
createdAt
string
required
updatedAt
string
required
evidence
object[] | null
required
certificate
object | null
required
visits
object[]
required
invoices
object[] | null
required