Update survey
curl --request PATCH \
--url https://api.pickfu.com/v1/surveys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tags": [
{
"id": "<string>"
}
],
"projectId": "<string>",
"projects": [
"<string>"
],
"questions": [
{
"prompt": "<string>",
"id": "<string>",
"variant": "<string>",
"context": {
"text": "<string>",
"mediaUrl": "<string>",
"type": "<string>",
"value": "<string>"
},
"options": [
{
"id": "<string>",
"value": "<string>",
"mediaUrl": "<string>",
"asin": "<string>",
"imageSet": [
"<string>"
],
"mockup": {
"image": "<string>",
"title": "<string>",
"numRatings": 123,
"reviewScore": 123,
"rating": 123,
"reviews": 123,
"price": 123,
"currency": "<string>"
}
}
]
}
],
"targeting": [
"<string>"
],
"reporting": [
"<string>"
],
"country": "<string>",
"sampleSize": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {}
}
'import requests
url = "https://api.pickfu.com/v1/surveys/{id}"
payload = {
"name": "<string>",
"tags": [{ "id": "<string>" }],
"projectId": "<string>",
"projects": ["<string>"],
"questions": [
{
"prompt": "<string>",
"id": "<string>",
"variant": "<string>",
"context": {
"text": "<string>",
"mediaUrl": "<string>",
"type": "<string>",
"value": "<string>"
},
"options": [
{
"id": "<string>",
"value": "<string>",
"mediaUrl": "<string>",
"asin": "<string>",
"imageSet": ["<string>"],
"mockup": {
"image": "<string>",
"title": "<string>",
"numRatings": 123,
"reviewScore": 123,
"rating": 123,
"reviews": 123,
"price": 123,
"currency": "<string>"
}
}
]
}
],
"targeting": ["<string>"],
"reporting": ["<string>"],
"country": "<string>",
"sampleSize": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tags: [{id: '<string>'}],
projectId: '<string>',
projects: ['<string>'],
questions: [
{
prompt: '<string>',
id: '<string>',
variant: '<string>',
context: {text: '<string>', mediaUrl: '<string>', type: '<string>', value: '<string>'},
options: [
{
id: '<string>',
value: '<string>',
mediaUrl: '<string>',
asin: '<string>',
imageSet: ['<string>'],
mockup: {
image: '<string>',
title: '<string>',
numRatings: 123,
reviewScore: 123,
rating: 123,
reviews: 123,
price: 123,
currency: '<string>'
}
}
]
}
],
targeting: ['<string>'],
reporting: ['<string>'],
country: '<string>',
sampleSize: '<string>',
surveyIntent: '<string>',
externalId: '<string>',
template: {}
})
};
fetch('https://api.pickfu.com/v1/surveys/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pickfu.com/v1/surveys/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tags' => [
[
'id' => '<string>'
]
],
'projectId' => '<string>',
'projects' => [
'<string>'
],
'questions' => [
[
'prompt' => '<string>',
'id' => '<string>',
'variant' => '<string>',
'context' => [
'text' => '<string>',
'mediaUrl' => '<string>',
'type' => '<string>',
'value' => '<string>'
],
'options' => [
[
'id' => '<string>',
'value' => '<string>',
'mediaUrl' => '<string>',
'asin' => '<string>',
'imageSet' => [
'<string>'
],
'mockup' => [
'image' => '<string>',
'title' => '<string>',
'numRatings' => 123,
'reviewScore' => 123,
'rating' => 123,
'reviews' => 123,
'price' => 123,
'currency' => '<string>'
]
]
]
]
],
'targeting' => [
'<string>'
],
'reporting' => [
'<string>'
],
'country' => '<string>',
'sampleSize' => '<string>',
'surveyIntent' => '<string>',
'externalId' => '<string>',
'template' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pickfu.com/v1/surveys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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))
}HttpResponse<String> response = Unirest.patch("https://api.pickfu.com/v1/surveys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pickfu.com/v1/surveys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"country": "<string>",
"currency": "<string>",
"sampleSize": 123,
"numResponses": 123,
"status": "<string>",
"targeting": [
"<string>"
],
"reporting": [
"<string>"
],
"reportingDefaultsApplied": [
"<string>"
],
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"projects": [
{
"id": "<string>",
"name": "<string>"
}
],
"surveyUrl": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {
"id": "<string>",
"name": "<string>",
"constraints": {
"questionTypes": [
"head_to_head"
],
"optionTypes": [
"text"
],
"optionCount": {
"min": 123,
"max": 123
},
"sampleSizes": [
"<string>"
],
"defaultSampleSize": "<string>",
"countries": [
"<string>"
],
"defaultCountry": "<string>"
}
},
"questions": [
{
"id": "<string>",
"type": "<string>",
"variant": "<string>",
"value": "<string>",
"translation": "<string>",
"likertScale": "agreement5",
"options": [
{
"id": "<string>",
"label": "<string>",
"value": "<string>",
"type": "<string>",
"translation": "<string>",
"product": {
"asin": "<string>",
"title": "<string>",
"price": 123,
"salePrice": 123,
"currency": "<string>",
"rating": 123,
"reviews": 123,
"reviewScore": 123,
"numRatings": 123,
"image": "<string>"
},
"imageSetDirection": "<string>",
"mockupType": "<string>"
}
],
"context": {
"type": "<string>",
"value": "<string>",
"translation": "<string>"
},
"results": {
"totalResponses": 123,
"winningOptionId": "<string>",
"averageScore": 123,
"options": [
{
"id": "<string>",
"label": "<string>",
"votes": 123,
"percentage": 123,
"rank": 123,
"isWinner": true
}
]
},
"responses": [
{
"id": "<string>",
"pinned": true,
"explanation": "<string>",
"translation": "<string>",
"chosenOption": "<string>",
"selectedOptions": [
"<string>"
],
"score": 123,
"clicks": [
{
"number": 123,
"xCoord": 123,
"yCoord": 123
}
],
"ranking": [
{
"rank": 123,
"option": "<string>"
}
],
"media": "<string>",
"mediaTranscription": "<string>",
"matchup": {
"option1": "<string>",
"option2": "<string>"
},
"statements": [
{
"id": "<string>",
"statement": "<string>",
"value": 123
}
],
"prices": {
"tooCheap": 123,
"bargain": 123,
"expensive": 123,
"tooExpensive": 123
},
"respondent": [
{
"trait": "<string>",
"value": "<string>"
}
]
}
],
"ai": {}
}
]
},
"cost": {
"amount": 123,
"balance": 123,
"currency": "<string>",
"canPayWithBalance": true,
"quotedCreditsCost": 123,
"creditsCostSubtotal": 123,
"discounts": [
[
"<string>"
]
],
"discountsMoney": [
[
"<string>"
]
],
"planRequired": "<string>"
},
"completionEstimate": {
"bucket": "<string>",
"estimatedMinutes": 123,
"status": "<string>"
}
}{
"statusCode": 123,
"error": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}"<string>""<string>""<string>"{
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>",
"violations": [
{
"code": "<string>",
"param": "<string>",
"message": "<string>",
"allowed": "<unknown>",
"received": "<unknown>"
}
],
"blanks": [
{
"name": "<string>",
"placeholder": "<string>"
}
]
}Surveys
Update survey
Updates a draft survey. All fields use replace-all semantics — for example, sending tags replaces all existing tags, and sending questions replaces all existing questions.
Only surveys in unpublished (draft) status can be updated. You can update the name, tags, project, questions, targeting, reporting, country, sample size, and survey intent.
PATCH
/
surveys
/
{id}
Update survey
curl --request PATCH \
--url https://api.pickfu.com/v1/surveys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tags": [
{
"id": "<string>"
}
],
"projectId": "<string>",
"projects": [
"<string>"
],
"questions": [
{
"prompt": "<string>",
"id": "<string>",
"variant": "<string>",
"context": {
"text": "<string>",
"mediaUrl": "<string>",
"type": "<string>",
"value": "<string>"
},
"options": [
{
"id": "<string>",
"value": "<string>",
"mediaUrl": "<string>",
"asin": "<string>",
"imageSet": [
"<string>"
],
"mockup": {
"image": "<string>",
"title": "<string>",
"numRatings": 123,
"reviewScore": 123,
"rating": 123,
"reviews": 123,
"price": 123,
"currency": "<string>"
}
}
]
}
],
"targeting": [
"<string>"
],
"reporting": [
"<string>"
],
"country": "<string>",
"sampleSize": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {}
}
'import requests
url = "https://api.pickfu.com/v1/surveys/{id}"
payload = {
"name": "<string>",
"tags": [{ "id": "<string>" }],
"projectId": "<string>",
"projects": ["<string>"],
"questions": [
{
"prompt": "<string>",
"id": "<string>",
"variant": "<string>",
"context": {
"text": "<string>",
"mediaUrl": "<string>",
"type": "<string>",
"value": "<string>"
},
"options": [
{
"id": "<string>",
"value": "<string>",
"mediaUrl": "<string>",
"asin": "<string>",
"imageSet": ["<string>"],
"mockup": {
"image": "<string>",
"title": "<string>",
"numRatings": 123,
"reviewScore": 123,
"rating": 123,
"reviews": 123,
"price": 123,
"currency": "<string>"
}
}
]
}
],
"targeting": ["<string>"],
"reporting": ["<string>"],
"country": "<string>",
"sampleSize": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tags: [{id: '<string>'}],
projectId: '<string>',
projects: ['<string>'],
questions: [
{
prompt: '<string>',
id: '<string>',
variant: '<string>',
context: {text: '<string>', mediaUrl: '<string>', type: '<string>', value: '<string>'},
options: [
{
id: '<string>',
value: '<string>',
mediaUrl: '<string>',
asin: '<string>',
imageSet: ['<string>'],
mockup: {
image: '<string>',
title: '<string>',
numRatings: 123,
reviewScore: 123,
rating: 123,
reviews: 123,
price: 123,
currency: '<string>'
}
}
]
}
],
targeting: ['<string>'],
reporting: ['<string>'],
country: '<string>',
sampleSize: '<string>',
surveyIntent: '<string>',
externalId: '<string>',
template: {}
})
};
fetch('https://api.pickfu.com/v1/surveys/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pickfu.com/v1/surveys/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tags' => [
[
'id' => '<string>'
]
],
'projectId' => '<string>',
'projects' => [
'<string>'
],
'questions' => [
[
'prompt' => '<string>',
'id' => '<string>',
'variant' => '<string>',
'context' => [
'text' => '<string>',
'mediaUrl' => '<string>',
'type' => '<string>',
'value' => '<string>'
],
'options' => [
[
'id' => '<string>',
'value' => '<string>',
'mediaUrl' => '<string>',
'asin' => '<string>',
'imageSet' => [
'<string>'
],
'mockup' => [
'image' => '<string>',
'title' => '<string>',
'numRatings' => 123,
'reviewScore' => 123,
'rating' => 123,
'reviews' => 123,
'price' => 123,
'currency' => '<string>'
]
]
]
]
],
'targeting' => [
'<string>'
],
'reporting' => [
'<string>'
],
'country' => '<string>',
'sampleSize' => '<string>',
'surveyIntent' => '<string>',
'externalId' => '<string>',
'template' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pickfu.com/v1/surveys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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))
}HttpResponse<String> response = Unirest.patch("https://api.pickfu.com/v1/surveys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pickfu.com/v1/surveys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tags\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"projectId\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"variant\": \"<string>\",\n \"context\": {\n \"text\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"options\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"asin\": \"<string>\",\n \"imageSet\": [\n \"<string>\"\n ],\n \"mockup\": {\n \"image\": \"<string>\",\n \"title\": \"<string>\",\n \"numRatings\": 123,\n \"reviewScore\": 123,\n \"rating\": 123,\n \"reviews\": 123,\n \"price\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"targeting\": [\n \"<string>\"\n ],\n \"reporting\": [\n \"<string>\"\n ],\n \"country\": \"<string>\",\n \"sampleSize\": \"<string>\",\n \"surveyIntent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"template\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"country": "<string>",
"currency": "<string>",
"sampleSize": 123,
"numResponses": 123,
"status": "<string>",
"targeting": [
"<string>"
],
"reporting": [
"<string>"
],
"reportingDefaultsApplied": [
"<string>"
],
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"projects": [
{
"id": "<string>",
"name": "<string>"
}
],
"surveyUrl": "<string>",
"surveyIntent": "<string>",
"externalId": "<string>",
"template": {
"id": "<string>",
"name": "<string>",
"constraints": {
"questionTypes": [
"head_to_head"
],
"optionTypes": [
"text"
],
"optionCount": {
"min": 123,
"max": 123
},
"sampleSizes": [
"<string>"
],
"defaultSampleSize": "<string>",
"countries": [
"<string>"
],
"defaultCountry": "<string>"
}
},
"questions": [
{
"id": "<string>",
"type": "<string>",
"variant": "<string>",
"value": "<string>",
"translation": "<string>",
"likertScale": "agreement5",
"options": [
{
"id": "<string>",
"label": "<string>",
"value": "<string>",
"type": "<string>",
"translation": "<string>",
"product": {
"asin": "<string>",
"title": "<string>",
"price": 123,
"salePrice": 123,
"currency": "<string>",
"rating": 123,
"reviews": 123,
"reviewScore": 123,
"numRatings": 123,
"image": "<string>"
},
"imageSetDirection": "<string>",
"mockupType": "<string>"
}
],
"context": {
"type": "<string>",
"value": "<string>",
"translation": "<string>"
},
"results": {
"totalResponses": 123,
"winningOptionId": "<string>",
"averageScore": 123,
"options": [
{
"id": "<string>",
"label": "<string>",
"votes": 123,
"percentage": 123,
"rank": 123,
"isWinner": true
}
]
},
"responses": [
{
"id": "<string>",
"pinned": true,
"explanation": "<string>",
"translation": "<string>",
"chosenOption": "<string>",
"selectedOptions": [
"<string>"
],
"score": 123,
"clicks": [
{
"number": 123,
"xCoord": 123,
"yCoord": 123
}
],
"ranking": [
{
"rank": 123,
"option": "<string>"
}
],
"media": "<string>",
"mediaTranscription": "<string>",
"matchup": {
"option1": "<string>",
"option2": "<string>"
},
"statements": [
{
"id": "<string>",
"statement": "<string>",
"value": 123
}
],
"prices": {
"tooCheap": 123,
"bargain": 123,
"expensive": 123,
"tooExpensive": 123
},
"respondent": [
{
"trait": "<string>",
"value": "<string>"
}
]
}
],
"ai": {}
}
]
},
"cost": {
"amount": 123,
"balance": 123,
"currency": "<string>",
"canPayWithBalance": true,
"quotedCreditsCost": 123,
"creditsCostSubtotal": 123,
"discounts": [
[
"<string>"
]
],
"discountsMoney": [
[
"<string>"
]
],
"planRequired": "<string>"
},
"completionEstimate": {
"bucket": "<string>",
"estimatedMinutes": 123,
"status": "<string>"
}
}{
"statusCode": 123,
"error": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}"<string>""<string>""<string>"{
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>",
"violations": [
{
"code": "<string>",
"param": "<string>",
"message": "<string>",
"allowed": "<unknown>",
"received": "<unknown>"
}
],
"blanks": [
{
"name": "<string>",
"placeholder": "<string>"
}
]
}Authorizations
OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}
Path Parameters
Survey GUID
Body
application/json
Survey name (1-255 characters, trimmed)
Required string length:
1 - 255Tags to replace all existing tags. Each item has either id or name.
Maximum array length:
10- Option 1
- Option 2
Show child attributes
Show child attributes
Project GUID (string) or numeric ID to associate, or null to remove project. Mutually exclusive with projects.
Project GUIDs (or numeric IDs) to associate the survey with. Replace-all semantics. Mutually exclusive with projectId.
Maximum array length:
50Questions to replace all existing questions (replace-all semantics)
Required array length:
1 - 24 elementsShow child attributes
Show child attributes
Targeting trait permalinks (replace-all semantics)
Reporting trait permalinks (replace-all semantics)
Two-letter country code (e.g. US)
Number of respondents. Standard surveys: "15", "30", "50", "75", "100", "200", "300", "500". Screen recording surveys: "5", "10", "15", "20", "25", "30", "50", "75" (max 75).
Original intent of the survey as interpreted by AI (max 255 characters)
Maximum string length:
255Optional opaque correlation key for your own records. Omit when unset. Case-sensitive and byte-exact — send the identical string every time. Many surveys may share the same id. We do not interpret this value.
Required string length:
1 - 255Create only: sending it here is a 400. Edit a draft made from a template with questions, using the ids from GET /v1/surveys/{id}; its edits must stay within the template limits shown in template.constraints.
Was this page helpful?