Skip to main content
POST
Create complaint

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
Minimum string length: 1
complainantKind
enum<string>
required
Available options:
tenant,
landlord,
other
contactId
string | null
required
complainantName
string
required
complainantEmail
string | null
required
complainantPhone
string | null
required
propertyId
string | null
required
repairId
string | null
required
channel
enum<string>
required
Available options:
phone,
email,
letter,
in_person,
online,
other
category
enum<string>
required
Available options:
repairs,
communication,
staff_conduct,
fees_charges,
deposit,
contractor,
other
summary
string
required
outcomeSought
string | null
required
receivedOn
string
required
handlerUserId
string | null
required

Response

Success

complaint
object
required
history
object[]
required
today
string
required