v1Resources/Reviews/postSend replies for client approval

Send replies for client approval

Asks client portal users to approve drafted replies, one request per review. Each item takes a reviewId and the reply text; leave text out to use the review's saved draft. The text is also saved as the review's draft. Every person in clientUserIds must be an active portal user of the review's client who can see the review's location. Content checks run first, and a reply they flag isn't sent. If the review already has an open request, it's updated in place: new text becomes a new version the client is asked about again, and new people are added to it. Each review succeeds or fails on its own, so the call returns 201 even when some items fail; check ok and code on every result. Client users get an email and an in-app notification, and requests sent close together reach each person as one message. If the email can't be sent, the request still waits in their portal.

post/api/v1/reviews/reply-approvals
reviews:write
Request body
itemsarray of objectrequired
The reviews to send, 1 to 200. Each review gets its own request.
reviewIdstringrequired
The review the reply answers.
textstringoptional
The reply to approve, up to 4096 characters. Leave it out to use the review's saved draft.
clientUserIdsarray of stringrequired
The client portal users to ask, 1 to 50, from the client's portal users list. Each one must be able to see the review's location, or that review fails with ineligible_assignee.
notestringoptional
An optional message for the client users, up to 2000 characters.
Response
dataobjectoptional
resultsarray of objectoptional
One result per item. Reviews that weren't found, or that belong to a client the token can't access, are listed last.
reviewIdstringoptional
The review this result is for.
okbooleanoptional
True when the request was created or updated.
requestIdstringoptional
The request's id, when ok is true.
errorstringoptional
Why this review wasn't sent, when ok is false.
codestring (not_found | not_respondable | no_draft | ineligible_assignee | content_checks)optional
Why it failed: not_found (no such review, or it belongs to a client the token can't access), not_respondable (the review can't be replied to in Synup, or already has a posted reply), no_draft (no text was sent and the review has no saved draft), ineligible_assignee (someone in clientUserIds can't see the review's location), or content_checks (content checks flagged the reply; fix it and send again).
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/reply-approvals
Your API key
Request body*
{}

Guides that use this resource