API Reference

Creates a note against a commercial viewing.

post
https://example.com/v2/commercial/viewings//notes

title is required; note carries the body and may be omitted. If userId is omitted
the first agent in the viewing's team is recorded as the author, since an API key
request has no signed-in agent of its own. Viewing feedback is held on the viewing
itself — use notes for anything else worth recording.

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

Commercial viewing id

Body Params

Note payload

string
required
length between 1 and 200
string | null
boolean
uuid | null

Optional agent id to record as the note's author. An API key request has no signed-in
agent behind it, so when this is omitted the first agent in the parent's team is used.

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

Updated 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 months ago

Did this page help you?