🚧

Only API keys on our Conversations platform are eligible to use this API version. Refer to the Platforms section of our Platform & API Concepts documentation to learn which platform your API keys are on.

The Conversations API lets you programmatically retrieve and submit Bazaarvoice Conversations data for use in your applications. To learn more, go to the Conversations API documentation home page.

📘

Try out Answer Submission API reference here.

Overview

Submission is divided into the following three HTTP operations controlled by the Action parameter:

Examples

The following examples demonstrate common Conversations API submission requests. For a complete overview of using the Conversations API to display data, refer to the display tutorials.

View an answer submission form

A QuestionId is required for all answer submissions. This action may be done with an HTTP POST or GET.

https://[stg.]api.bazaarvoice.com/data/submitanswer.json?ApiVersion=[latestApiVersion]&QuestionId=[questionId]&UserId=[userId]&PassKey=[yourKey]

View an answer submission form prepopulated with user data

Use either the User or UserId parameter depending on your API key configuration. This action may be done with an HTTP POST or GET.

https://[stg.]api.bazaarvoice.com/data/submitanswer.[FORMAT]?ApiVersion=[latestApiVersion]&QuestionId=[questionId]&PassKey=[yourKey]&User|UserId=[valueOfUserOrUserId]

Preview an answer submission

A QuestionId is required for all answer submissions. This action may be done with an HTTP POST or GET.

https://[stg.]api.bazaarvoice.com/data/submitanswer.json?ApiVersion=[latestApiVersion]&QuestionId=[questionId]&Action=preview&AnswerText=[answerText]&UserId=[userId]&PassKey=[yourKey]

Submit an answer

POST /data/submitanswer.json HTTP/1.1
Host: [stg.]api.bazaarvoice.com
Content-Type: application/x-www-form-urlencoded
X-Forwarded-For: [AuthorIPAddress]
...

ApiVersion=[latestApiVersion]&QuestionId=[questionId]&Action=submit&AnswerText=[answerText]&UserId=[userId]&PassKey=[yourKey]&fp=[deviceFingerPrint]

Ellipses (...) in above example indicate that your app may generate other headers.

A QuestionId is required for all answer submissions. Answers must be submitted on a question and take the form of an HTTP POST.

Headers

Your app may generate other headers.

Parameters

Response format

🚧

Do not reuse the API passkey below in your application.

Preview an answer submission:

https://stg.api.bazaarvoice.com/data/submitanswer.json?apiversion=5.4&QuestionId=646785&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&action=preview

The following is an example of an answer submission response after submitting the form by HTTP POST:

{
   "Data":{},
   "HasErrors":false,
   "Form":[],
   "FormErrors":{},
   "Answer":{
     "SendEmailAlertWhenPublished":false,
     "SubmissionTime":"2011-11-16T13:51:01.196-00:00",
     "TypicalHoursToPost":null,
     "Id":null,
     "SubmissionId":null,
     "AnswerText":"texttexttexttexttexttexttexttext"
   },
   "TypicalHoursToPost":72,
   "SubmissionId":"slb5oxhvfni4vcfwck3rq0vuk",
   "Locale":"en_US",
   "Errors":[]
}

Response elements

Error codes