Response API: Programmatically create, read, update, and delete responses to reviews using a secure HTTP interface.
Author
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 the response Author resource. The Author resource is the writer of the review response.
Request
The following code block shows a sample request. Go to the Tools section to access interactive tools and applications that help you work with the Response API.
GET https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/{responseGuid}/author?passkey={PRIVACY_API_PASSKEY} HTTP/1.1 Authorization: Bearer {ACCESS_TOKEN} …
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 |
The ID for a given response. |
Yes |
QueryString |
||
passkey |
Privacy API passkey. |
Yes |
Header |
||
Authorization |
The Authorization value will consist of the string |
Yes |
Response
Header
An HTTP status 200 indicates success. Other header values are documented in the Overview.
Body
A successful response will contain a JSON object in the body. The following demonstrates a typical successful creation of a client response:
{ "data": { "type": "author", "id": "1" }, "links": { "self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author", "related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author" } }
The response syntax follows the JSON API specification, exposing data
, links
, and relationships
nodes.
Errors
Please see Troubleshooting for a detailed description and solution for Response API errors.