Skip to main content
PUT
Save licence application

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
id
string | null
required
propertyId
string
required
kind
enum<string>
required
Available options:
new,
renewal
licenceType
enum<string> | null
required
Available options:
mandatory_hmo,
additional,
selective
council
string | null
required
stage
enum<string>
required
Available options:
started,
documents,
submitted,
inspection,
granted,
refused,
withdrawn
startedOn
string
required
submittedOn
string | null
required
inspectionOn
string | null
required
decidedOn
string | null
required
reference
string | null
required
feeMinor
required
feePaidOn
string | null
required
floorPlanDocumentId
string | null
required
note
string | null
required
expectedRevision
required

Response

Success

id
string
required
propertyId
string
required
kind
enum<string>
required
Available options:
new,
renewal
licenceType
enum<string> | null
required
Available options:
mandatory_hmo,
additional,
selective
council
string | null
required
stage
enum<string>
required
Available options:
started,
documents,
submitted,
inspection,
granted,
refused,
withdrawn
startedOn
string
required
submittedOn
string | null
required
inspectionOn
string | null
required
decidedOn
string | null
required
reference
string | null
required
feeMinor
required
feePaidOn
string | null
required
floorPlanDocumentId
string | null
required
note
string | null
required
open
boolean
required
revision
required