Synup
Create a key
v1Resources/Reviews/getGet a reply approval's timeline

Get a reply approval's timeline

Returns every event on one reply approval request, oldest first: when it was requested, sent, opened, edited, commented on, decided, posted, withdrawn or canceled. Returns 404 if the request doesn't exist or belongs to a client the token can't access.

get/api/v1/reviews/reply-approvals/{id}
reviews:read
Query parameters
idstringrequired
The request's id: id from the list response, or requestId from a send result.
Response
dataobjectoptional
eventsarray of objectoptional
The request's events, oldest first.
idstringoptional
The event's id.
typestring (requested | notified | email_skipped | reminded | opened_email | viewed_portal | edited_client | edited_agency | commented | changes_requested | approved | scheduled | posted | failed | withdrawn | cancelled)optional
What happened: requested, notified, email_skipped, reminded, opened_email, viewed_portal, edited_client, edited_agency, commented, changes_requested, approved, scheduled, posted, failed, withdrawn or cancelled.
actorTypestring (user | client_user | system)optional
Who acted: user (your agency, API calls included), client_user, or system.
actorNamestringoptional
The person's name. Null for system events and API calls.
dataobjectoptional
Details that vary by type, such as a comment's body or the text before and after an edit.
atstringoptional
When it happened.
Errors
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.
get/api/v1/reviews/reply-approvals/{id}
Your API key
id *
{}

Guides that use this resource