actionstring
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.
AgreedToTermsAndConditionsboolean
Boolean indicating whether or not the user agreed to the terms and conditions. Required depending on the client's settings.
AdditionalField_<Dimension-External-Id>string
A concrete example of the parameter might be 'AdditionalField_Seat' with a value of '24F' (describing the seat number at a stadium or on a plane).
campaignIdstring
Arbitrary text that may be saved alongside content to indicate vehicle by which content was captured, e.g. “post-purchase email”.
ContextDataValue_<Dimension-External-Id>string
Some examples of this parameter include the following. Each is followed by possible values.
ContextDataValue_PurchaserRank - "top", "top10", "top100", "top1000"
ContextDataValue_Purchaser - "yes", "no"
ContextDataValue_Age - "under21", "21to34", "35to44", "45to54", "55to64", "over65"
ContextDataValue_Gender - "male", "female"
fpstring
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.
HostedAuthentication_AuthenticationEmailstring
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_CallbackUrlstring
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.
isRecommendedboolean
Value is true or false; default is null – "true" or "false" answer to "I would recommend this to a friend". Required dependent on client settings.
Localestring
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.
NetPromoterCommentstring
Value is text representing a user comment to explain numerical Net Promoter score.
NetPromoterScoreinteger
Value is positive integer between 1 and 10 representing a numerical rating in response to “How would you rate this company?”
PhotoUrl_<n>string
Value is a Bazaarvoice URL of a photo uploaded using the Data API, where <n> is a non-negative integer. See our photo upload tutorial for more information.
PhotoCaption_<n>string
Value is caption text for the photo URL with the same value of <n>.
ratinginteger
Value is positive integer between 1 and 5, and represents review overall rating.
Rating_<Dimension-External-Id>integer
A concrete example might be Rating_Quality where the value would represent the user's opinion of the quality of the product. The value is a positive integer between 1 and 5 and represents rating dimension value.
reviewTextstring
Value is review body text. If the text is less than 50 characters, it will be considered as a ratings-only review.
titlestring
Value is content title text. The minimum and maximum lengths are configurable. The current default is 50 characters, but can be lower to 1 or higher to 255.
tag_<Dimension-External-Id>_<n>string
A concrete example of the parameter might be 'tag_Pro_1'. Valid values could be any free-form text. <n> should be a non-negative integer starting at the number 1.
tagid_<Dimension-External-Id>/<Tag-Label>boolean
Boolean indicating whether or not the tag applies to the user. A concrete example might be 'tagid_Pro/EasyToUse=true'.
userstring
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.
userIdstring
User's external ID. It should only contain alphanumeric characters, hyphens (-), and underscores (_). No other special characters should be used. Can be encoded in UserToken or sent as plain text, depending on API key configuration. Must not contain any personally identifiable information (PII) data, particularly email address.
UserEmailstring
User's email address.
userNicknamestring
User nickname display text.
UserLocationstring
User location text.
SendEmailAlertWhenCommentedboolean
Boolean indicating whether or not the user wants to be notified when a comment is posted on the content.
SendEmailAlertWhenPublishedboolean
Boolean indicating whether or not the user wants to be notified when his/her content is published.
VideoUrl_1string
Value is valid URL to a YouTube video where <n> is a non-negative integer.
VideoCaption_1string
Value is caption text for the video URL with the same value of <n>.
