initiateSubmit

post https://stg.api.bazaarvoice.com/data/initiateSubmit.json

Endpoint to request product info for setting up a review submission form

Query Params

passkey

string

required

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

apiVersion

number

required

The API version, e.g. 5.4.

action

string

Action is always submit

userId

string

required

Unique id for user. 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.

displayCode

string

hostedauth

string

Indicates the action being performed, is using hosted authentication

Body Params

locale

string

Locale information

productIds

array of strings

List of product identifiers

productIds

Headers

Content-Type

string

required

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://stg.api.bazaarvoice.com/data/initiateSubmit.json \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

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

defaultUnexpected Error