Skip to main content
POST
Record notice

Authorizations

x-api-key
string
header
required

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

Path Parameters

tenancyId
string
required
direction
enum<string>
required
Available options:
move_in,
move_out

Body

application/json
requestId
string
required
expectedRevision
required
receivedOn
string
required
method
enum<string>
required
Available options:
in_person,
email,
letter,
text,
phone,
other
documentId
string · null · null
notes
string · null · null

Response

Success

tenancyId
string
required
tenancyStatus
enum<string>
required
Available options:
active,
notice_given,
ended
startsOn
string | null
required
endsOn
string | null
required
noticeGivenOn
string | null
required
unitId
string
required
propertyId
string | null
required
occupants
object[]
required
moveIn
object | null
required
moveOut
object | null
required
checkIn
object | null
required
checkOut
object | null
required
inspectionsReadable
boolean
required
followUps
object[] | null
required
keys
object | null
required
outstanding
object[]
required