Skip to main content
Requests

Create a request

POST
/requests
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
assessmentobject
assigned_tostring[]
Maximum array length: 50
contactobject
notesstring
Maximum string length: 10000
property_idinteger
Required range: 0 < x

Response

application/json

The request, never a draft. With an assessment and no assigned_to, the assessment team becomes the assignees; the "Assessment booked" text goes out when the company has it on.

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

archivedbooleanrequired
archived_atstring | nullrequired
assessmentobject | nullrequired

The live assessment; cancelled ones are not shown

assigned_tostring[]required
completed_atstring | nullrequired
contactobject | nullrequired
created_atstringrequired
created_fromobject | nullrequired
display_numberstringrequired
Example: R-12
idstringrequired
notesstringrequired
numberintegerrequired
property_idinteger | nullrequired
statusenum<string>required

Derived; never set by a client

Available options: draft, new, scheduled, completed
updated_atstringrequired