Submit an answer

post

https://stg.api.bazaarvoice.com/data/submitanswer.json

Query Params

ApiVersion

string

required

The API version, e.g. 5.4.

PassKey

string

required

API key is required to authenticate API user and check permission to access particular client's data.

Form Data

QuestionId

string

The id of the question that this answer is being submitted on.

Action

string

The submission action to take -- either 'Action=', 'Action=Preview' or 'Action=Submit'. 'Action=' will show information that can be used to build a submission form, 'Action=Preview' will show a draft of the content to be submitted; 'Action=Submit' will submit the content. If 'Action=Submit', the request must be an HTTP POST.

AnswerText

string

Contains the text of the answer.

UserId

string

User's external ID. This value should come from your authentication system. See Client-Mastered Authentication for more information.

Alert Do not use an email address for this value.

string

Fingerprint of content author's device. See the Authenticity Tutorial for more information.

Per the Bazaarvoice Authenticity Policy, you must send a device fingerprint attached to each submission. If you fail to send a device fingerprint with your submission, Bazaarvoice may take any action deemed necessary in Bazaarvoice’s sole discretion to protect the integrity of the network. Such actions may include but are not limited to: rejection of your content, halting syndication of your content on the Bazaarvoice network, revocation of your API key, or revocation of your API license.

Alert Failure to submit this field will result in your content being ineligible for syndication, authenticity or other business processes.

AgreedToTermsAndConditions

boolean

Boolean indicating whether or not the user agreed to the terms and conditions. Required depending on the client's settings.

CampaignId

string

Arbitrary text that may be saved alongside content to indicate vehicle by which content was captured, e.g. “post-purchase email”.

HostedAuthentication_AuthenticationEmail

string

Email address where the submitter will receive the confirmation email. If you are configured to use hosted email authentication, this parameter is required. See the Authenticate User method for more information on hosted authentication.

HostedAuthentication_CallbackUrl

string

URL of the link contained in the user authentication email. This should point to a landing page where a web application exists to complete the user authentication process. The host for the URL must be one of the domains configured for the client. The link in the email will contain a user authentication token (authtoken) that is used to verify the submitter. If you are configured to use hosted email authentication, this parameter is required. See the hosted authentication tutorial for more information

Locale

string

Locale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key.

Alert Failure to submit this field will result in your content being ineligible for syndication, authenticity or other business processes.

PhotoCaption_<n>

string

Value is caption text for the photo URL with the same value of .

PhotoUrl_<n>

string

Value is a Bazaarvoice URL of a photo uploaded using the Data API, where is a non-negative integer.

SendEmailAlertWhenPublished

boolean

Boolean indicating whether or not the user wants to be notified when his/her content is published.

User

string

Value of the encrypted user. This parameter demonstrates that a user has been authenticated. Note that the UserId parameter does not contain authentication information and should not be used for hosted authentication. See the Authenticate User method for more information.

UserEmail

string

User's email address.

UserLocation

string

User location text.

UserNickname

string

length between 4 and 25

User nickname display text.

Headers

X-Forwarded-For

number

IP address of content author. This header is only necessary when performing submissions from your server. See Authenticity Tutorial for more information.

Per the Bazaarvoice Authenticity Policy, you must send author IP address attached to each submission. If you fail to send author IP address with your submission, Bazaarvoice may take any action deemed necessary in Bazaarvoice’s sole discretion to protect the integrity of the network. Such actions may include but are not limited to: rejection of your content, halting syndication of your content on the Bazaarvoice network, revocation of your API key, or revocation of your API license.

Alert Failure to submit this field will result in your content being ineligible for syndication, authenticity or other business processes.

Content-Type

string

required

The media-type type of the request body. Value must be application/x-www-form-urlencoded.
Required This field is required in all API requests.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response

400Bad Request - Missing required parameter.

401Unauthorized - Authentication or authorization failed. The provided credentials or authentication tokens are invalid or insufficient.

403Forbidden.

404Not Found

414Request-URI too long

defaultUnexpected Error