Changes a lettings property's board

Scope: write:boards

Does what Loop's board panel does: sets the property's board, records a board job with the
current board contractor, and writes Loop's "Board Type updated" note. No email is sent to
the contractor.

boardType and action are required. Changing to notRequired when the property has any
other board, or none set yet, is always recorded as needsTakingDown, as in Loop.
markAsDone records the job as done now.
userId must be an agent in the property's team; it defaults to the team's first agent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Lettings property id

Body Params

The new board

string
enum
required
Allowed:
string
enum
required
Allowed:
string | null

Notes for the contractor, kept on the board job.

boolean

Record the job as already done, now. Default false.

uuid | null

Recorded as the agent who made the change. Must be in the property's team; default its first agent.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

403

The API key doesn't have the scope this endpoint needs.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
*/*