Add a question to a review question set

curl --request POST \
  --url https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "prompt": "<string>",
  "type": "<string>",
  "options": [
    "<string>"
  ],
  "is_required": true,
  "position": 123,
  "aggregate_as_facet": true
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: '<string>',
    type: '<string>',
    options: ['<string>'],
    is_required: true,
    position: 123,
    aggregate_as_facet: true
  })
};

fetch('https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions"

payload = {
    "prompt": "<string>",
    "type": "<string>",
    "options": ["<string>"],
    "is_required": True,
    "position": 123,
    "aggregate_as_facet": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"type\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"is_required\": true,\n  \"position\": 123,\n  \"aggregate_as_facet\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'type' => '<string>',
    'options' => [
        '<string>'
    ],
    'is_required' => true,
    'position' => 123,
    'aggregate_as_facet' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "aggregate_as_facet": true,
    "id": "<string>",
    "is_required": true,
    "options": [
      "<string>"
    ],
    "position": 123,
    "prompt": "<string>",
    "set_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

POST

api

review-question-sets

{setId}

questions

Add a question to a review question set

curl --request POST \
  --url https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "prompt": "<string>",
  "type": "<string>",
  "options": [
    "<string>"
  ],
  "is_required": true,
  "position": 123,
  "aggregate_as_facet": true
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: '<string>',
    type: '<string>',
    options: ['<string>'],
    is_required: true,
    position: 123,
    aggregate_as_facet: true
  })
};

fetch('https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions"

payload = {
    "prompt": "<string>",
    "type": "<string>",
    "options": ["<string>"],
    "is_required": True,
    "position": 123,
    "aggregate_as_facet": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"type\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"is_required\": true,\n  \"position\": 123,\n  \"aggregate_as_facet\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/review-question-sets/{setId}/questions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'type' => '<string>',
    'options' => [
        '<string>'
    ],
    'is_required' => true,
    'position' => 123,
    'aggregate_as_facet' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "aggregate_as_facet": true,
    "id": "<string>",
    "is_required": true,
    "options": [
      "<string>"
    ],
    "position": 123,
    "prompt": "<string>",
    "set_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

setId

string

required

Body

application/json

APPENDS a new question. It cannot change an existing one: there is deliberately no matching PUT on a single question, because a type change on a question that already has shopper answers would leave those answers interpreted against the wrong column, silently.

prompt

string

required

Required. The text the shopper reads.

type

string

required

Required. One of text, single_select, multi_select. Decides how options and the stored answer are interpreted.

options

string[]

Required for single_select and multi_select, refused for text. The choice list a shopper picks from.

is_required

boolean

Optional, defaults to false. Whether a shopper must answer before submitting.

position

integer

Optional, defaults to 0. The order the form presents questions in.

aggregate_as_facet

boolean

Optional, defaults to false. Whether this question's answers roll into the product's published facet_summary.

Response

Created

data

object

Show child attributes

Customers

Customer groups

Segments

Companies

Staff members

Trade credit terms

Trade credit ledger

Wishlist items

Restock alerts

Loyalty

Store credit accounts

Reviews

Review groups

Review queue

Review settings

Review tags

Review question sets

Review request settings

Review assignments

API Reference

Add a question to a review question set

Authorizations

Headers

Path Parameters

Body

Response