v1Resources/Reviews/patchShare or unshare a review note

Share or unshare a review note

Sets whether one of your agency's notes on a review is shared with the client in the client portal (shared) or kept to the agency (internal). Only the visibility changes; the note's text stays as written. A note written by the client is always shared and can't be changed (403), and a note that isn't on this review is 404. A token limited to specific clients can only change notes on those clients' reviews.

patch/api/v1/reviews/notes
reviews:write
Request body
reviewIdstringrequired
The review the note belongs to.
noteIdstringrequired
The note to change.
visibilitystring (internal | shared)required
shared to show the note to the client in the client portal, or internal to keep it to the agency.
Response
dataobjectoptional
updatedbooleanoptional
visibilitystring (internal | shared)optional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/reviews/notes
Your API key
Request body*
{}

Guides that use this resource