Skip to main content
POST
Add landlord

Authorizations

x-api-key
string
header
required

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

Body

application/json
kind
enum<string>
required
Available options:
person,
company
firstName
string · null · null
lastName
string · null · null
companyName
string · null · null
contactFirstName
string · null · null
contactLastName
string · null · null
companyNumber
string · null · null
email
string · null · null
phone
string · null · null
prefers
enum<string> · null · null
Available options:
email,
phone,
post
postalAddress
object · null · null
role
enum<string> | null
Available options:
landlord,
freeholder,
head-lessor,
managing-agent

Response

Success

contactId
string
required
companyId
string | null
required
contactPersonId
string | null
required
name
string
required