Submit Question

Submit a question

POST/data/submitquestion.json

Use it in a workflow

Add a step and choose the Bazaarvoice connector.
Pick the Submit Question action (under submission).
Fill in the fields below, then reference the result from later steps as {{submitQuestion.response.data}}.

Request

Query parameters

ApiVersionstringrequired

The API version, e.g. 5.4.

ProductIdstringrequired

The id of the product that this content is being submitted on.

userIdstringrequired

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

questionsummarystringrequired

Contains the text of the question summary. Only a single line of text is allowed.

PassKeystringrequired

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

Headers

X-Forwarded-Fornumber

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-Typestringrequired

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.

Request body

Enter the body as JSON in the step's Body field.

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.

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.

AgreedToTermsAndConditionsboolean

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

CampaignIdstring

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

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.

IsUserAnonymousboolean

Boolean value. If IsUserAnonymous is true, the user's display name will not be shown with the question. This parameter is unrelated to UserId. This parameter can be turned off on a per client basis.

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.

PhotoCaption_<n>string

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

PhotoUrl_<n>string

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

QuestionDetailsstring

Contains the text of the question details. Multiple lines of text are allowed.

QuestionSummarystring

Contains the text of the question summary. Only a single line of text is allowed.

SendEmailAlertWhenAnsweredboolean

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

SendEmailAlertWhenPublishedboolean

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

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.

UserEmailstring

User's email address.

UserIdstring

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.

UserLocationstring

User location text.

UserNicknamestring

User nickname display text.

json

{
  "Action": "preview",
  "fp": "0400Ia/vP4SUWbEXk1Rjuv1iJmSjiw6jjNGA14xr7X6xRXldg3Eo6XtD78oKt7mA8bo/mtBit",
  "AgreedToTermsAndConditions": "false",
  "CampaignId": "Campaign_1",
  "HostedAuthentication_AuthenticationEmail": "dummy@dummy.com",
  "HostedAuthentication_CallbackUrl": "https://dummy.com",
  "IsUserAnonymous": "false",
  "Locale": "en_US",
  "PhotoCaption_<n>": "Dummy caption for photo",
  "PhotoUrl_<n>": "https://dummy.com/abc.jpg",
  "QuestionDetails": "About the quality and durability of product.",
  "QuestionSummary": "How do I get it autoshipped every month?"
}

Response

Returns 200 with an object. Read it in later steps with {{submitQuestion.response.data.<field>}}.

Dataobject

HasErrorsboolean

Formarray<object>

FormErrorsobject

Questionobject

SendEmailAlertWhenPublishedboolean

Flag indicating whether to send an email alert when the question is published.

SendEmailAlertWhenAnsweredboolean

Flag indicating whether to send an email alert when the question is answered.

QuestionSummarystring

The summary of the question.

SubmissionTimestring

The submission time of the question.

TypicalHoursToPostnumber

The typical number of hours it takes for the question to be posted.

SubmissionIdstring

The submission ID of the question.

QuestionDetailsstring

The details of the question.

TypicalHoursToPostnumber

The typical number of hours it takes for a submission to be posted.

SubmissionIdstring

The submission ID.

Localestring

The locale of the question.

Errorsarray<object>

json

{
  "Data": {},
  "HasErrors": false,
  "Form": [
    {}
  ],
  "FormErrors": {},
  "Question": {
    "SendEmailAlertWhenPublished": false,
    "SendEmailAlertWhenAnswered": false,
    "QuestionSummary": "string",
    "SubmissionTime": "string",
    "TypicalHoursToPost": 0,
    "SubmissionId": "string",
    "QuestionDetails": "string"
  },
  "TypicalHoursToPost": 0,
  "SubmissionId": "string",
  "Locale": "string",
  "Errors": [
    {}
  ]
}

Need more? See the Bazaarvoice guide for connection setup and behaviour shared by every action.

Was this page helpful?