Response API: Programmatically create, read, update, and delete responses to reviews using a secure HTTP interface.
Update Client Response
The Bazaarvoice Response API lets you programmatically manage review responses. To learn more, go to the Response API documentation home page.
Contents
This page describes how to update a given client response record.
Request
PATCH https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/{responseGuid}?passkey={RESPONSE_API_PASSKEY} HTTP/1.1 Content-Type: application/json Authorization: Bearer {ACCESS_TOKEN} … { "attributes": { "department": "string", "response": "string", "responseBy": "string" } }
attributes
, department
, and response
elements. https://[stg.]api.bazaarvoice.com/contentmanagement
as the base URL for the Response API, instead of https://[stg.]api.bazaarvoice.com/response
. The contentmanagement
URL has been deprecated. However, Bazaarvoice will continue to support applications that use the contentmanagement
URL until further notice.Ellipses (…) in above example indicate that your app may generate other headers.
Parameters
Name | Description | Required |
---|---|---|
Path |
||
responseGuid |
Guid of the review response. |
Yes |
QueryString |
||
passkey |
Response API passkey. |
Yes |
Header |
||
Content-Type |
application/json. |
Yes |
Authorization |
The Authorization value will consist of the string |
Yes |
Body |
||
attributes |
Container node that wraps the |
Yes |
department |
The department name (string) providing the response. |
No |
response |
The textual (string) response to the review. Limited to 65,535 characters. |
No |
responseBy |
The name of the responder. If you don't specify a name, the value defaults to the name of the Bazaarvoice Portal user that provided OAuth authorization for the application. |
No |
Response
Header
HTTP status 200 indicates success. Other header values are documented in the Overview.
Body
The response will contain a JSON object in the body. The following demonstrates a typical successful GET of a client response record:
{ "type": "clientResponse", "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "attributes": { "department": "Some department name - updated", "response": "This is a sample client response.", "responseBy": "Name of responder", "responseSource": "Name of Application created for OAuth", "created": "2018-06-22T19:55:03Z", "updated": "2018-06-27T14:32:15Z" }, "relationships": { "author": { "data": { "type": "author", "id": "Dav OAuth" }, "links": { "self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/author", "related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author" } }, "review": { "data": { "type": "review", "id": "75266", "clientName": "apitestcustomer" }, "links": { "self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/review", "related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/review" } } }, "links": { "self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } }
The definition of the key/values returned in the response body are documented in the Overview.
The updated
value now will be the timestamp of executed PATCH.
The responseSource
node value in the response is obtained from the OAuth application created by Bazaarvoice when providing access to the Client Response API. This value cannot be overridden in the submission POST
Contents within the relationships
node are provided as part of the JSON API specification.
Errors
Please see Troubleshooting for a detailed description and solution for Response API errors.
Duplicate response
text is submitted for the same reviewId:
{ "httpCode": 400, "requestURI": "/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "errors": [ { "code": "INVALID_PROPERTY_VALUE", "field": "response", "message": "Duplicate '{response text}' detected for ClientResponse.response" } ] }
Considerations
Moderation
Client responses should be provided by individuals with product and brand expertise. Moderation does not exist for the Bazaarvoice Client Response API. The configurations associated with user generated content, such as reviews, are not considered.
Time to live
All actions within the Bazaarvoice Client Response API are 'near real time'. Successful modifications, creations, and deletions affecting content are only dependent on the time for the Bazaarvoice caches to update. Client-implemented caching will also affect the rate at which responses appear.