Skip to main content
POST
Add occupier

Authorizations

x-api-key
string
header
required

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

Path Parameters

propertyId
string
required

Body

application/json
kind
enum<string>
required
Available options:
person,
company
movedInOn
string
required
unitId
string · null · null
firstName
string · null · null
lastName
string · null · null
companyName
string · null · null
contactFirstName
string · null · null
contactLastName
string · null · null
others
object[] | null
email
string · null · null
phone
string · null · null
prefers
enum<string> · null · null
Available options:
sms,
phone,
email
occupancyType
enum<string> · null · null
Available options:
assured_shorthold,
periodic,
licence,
company_let
accessNeeds
enum<string>[] | null
Available options:
mobility,
hearing,
sight,
learning_disability,
mental_health,
other
contractorRisks
enum<string>[] | null
Available options:
pets,
aggressive_behaviour,
hoarding,
medical_equipment,
other
gettingIn
enum<string> · null · null
Available options:
occupier,
key_held,
key_safe
contractorNotes
string · null · null

Response

Success

contactId
string
required
companyId
string | null
required
contactPersonId
string | null
required
otherContactIds
string[]
required
tenancyId
string
required
unitId
string
required
accessRevision
required