younifyd
Menu

Post Data Initiatesubmit Json

initiateSubmit

POST/data/initiateSubmit.json

Use it in a workflow

  1. Add a step and choose the Bazaarvoice connector.
  2. Pick the Post Data Initiatesubmit Json action (under submission).
  3. Fill in the fields below, then reference the result from later steps as {{postDataInitiatesubmitJson.response.data}}.

Request

Query parameters

passkeystringrequired

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

apiVersionnumberrequired

The API version, e.g. 5.4.

actionstring

Action is always submit

userIdstringrequired

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.

displayCodestring
hostedauthstring

Indicates the action being performed, is using hosted authentication

Headers

Content-Typestringrequired

Request body

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

localestring

Locale information

productIdsarray<string>

List of product identifiers

json
{
  "locale": "string",
  "productIds": [
    "string"
  ]
}

Response

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

hasErrorsboolean
responseobject
productFormDataobject1 fields
userIdstring
json
{
  "hasErrors": false,
  "response": {
    "productFormData": {
      "product1": {
        "review": {
          "submissionID": "string",
          "productExternalID": "string",
          "submissionTime": "string"
        },
        "fieldsOrder": [
          "string"
        ],
        "fields": {
          "Quality": {
            "autoPopulate": false,
            "label": "string",
            "id": "string",
            "type": "string",
            "class": "string",
            "required": false
          },
          "Value": {
            "autoPopulate": false,
            "label": "string",
            "id": "string",
            "type": "string",
            "class": "string",
            "required": false
          },
          "rating": {
            "id": "string",
            "type": "string",
            "class": "string"
          },
          "authenticationemail": {
            "required": false,
            "hidden": false,
            "id": "string",
            "type": "string",
            "class": "string"
          },
          "Gender": {
            "valuesLabels": {
              "Male": null,
              "Female": null
            },
            "autoPopulate": false,
            "label": "string",
            "id": "string",
            "type": "string",
            "class": "string",
            "required": false
          },
          "title": {
            "required": false,
            "hidden": false,
            "id": "string",
            "type": "string",
            "class": "string"
          },
          "reviewtext": {
            "required": false,
            "hidden": false,
            "id": "string",
            "type": "string",
            "class": "string"
          },
          "Age": {
            "valuesLabels": {
              "17orUnder": null,
              "18to24": null,
              "25to34": null,
              "35to44": null,
              "45to54": null,
              "55to64": null,
              "65orOver": null
            },
            "autoPopulate": false,
            "label": "string",
            "id": "string",
            "type": "string",
            "class": "string",
            "required": false
          },
          "usernickname": {
            "required": false,
            "hidden": false,
            "id": "string",
            "minLength": 0,
            "type": "string",
            "class": "string"
          },
          "useremail": {
            "required": false,
            "hidden": false,
            "id": "string",
            "type": "string",
            "class": "string"
          }
        },
        "submissionSessionToken": "string"
      }
    },
    "userId": "string"
  }
}

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