Skip to main content
POST
Add general contact

Authorizations

x-api-key
string
header
required

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

Body

application/json
firstName
string
required
propertyScope
enum<string>
required
Available options:
general,
all,
some
contactType
enum<string>
required
Available options:
next_of_kin,
other_occupier,
advocate,
ombudsman,
councillor,
solicitor,
council,
social,
insurance,
specialist,
utility,
other,
building_manager,
emergency_line
lastName
string · null · null
email
string · null · null
phone
string · null · null
prefers
enum<string> · null · null
Available options:
email,
phone,
post
propertyIds
string[] | null
jobTitle
string · null · null
organisation
string · null · null
relationship
enum<string> · null · null
Available options:
partner,
parent,
son_or_daughter,
brother_or_sister,
friend,
carer,
other
reference
string · null · null
actingForContactId
string · null · null
notes
string · null · null

Response

Success

id
string
required
kind
string
required
name
string
required
firstName
string | null
required
lastName
string | null
required
email
string | null
required
mobile
string | null
required
addressLine1
string | null
required
addressLine2
string | null
required
addressTown
string | null
required
addressPostcode
string | null
required
overseas
boolean
required
archivedAt
string | null
required
createdAt
string
required
roles
string[]
required
companyId
string | null
required
companyRevision
required
companyRole
string | null
required
mergedIntoId
string | null
required
mergedAt
string | null
required
accessNeeds
enum<string>[]
required
Available options:
mobility,
hearing,
sight,
learning_disability,
mental_health,
other
contractorRisks
enum<string>[]
required
Available options:
pets,
aggressive_behaviour,
hoarding,
medical_equipment,
other
contactType
enum<string> | null
required
Available options:
next_of_kin,
other_occupier,
advocate,
ombudsman,
councillor,
solicitor,
council,
social,
insurance,
specialist,
utility,
other,
building_manager,
emergency_line
propertyScope
enum<string> | null
required
Available options:
general,
all,
some
propertyIds
string[]
required
organisation
string | null
required
jobTitle
string | null
required
relationship
enum<string> | null
required
Available options:
partner,
parent,
son_or_daughter,
brother_or_sister,
friend,
carer,
other
reference
string | null
required
actingForContactId
string | null
required
notes
string | null
required