Create Survey
curl --request POST \
--url https://{baseurl}/api/v1/management/surveys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data @- <<EOF
{
"autoClose": null,
"autoComplete": null,
"autoSelectLanguage": null,
"createdBy": null,
"delay": 0,
"displayLimit": null,
"displayOption": "displayOnce",
"displayPercentage": null,
"endings": [
{
"buttonLabel": {
"default": "Create your own Survey"
},
"buttonLink": "https://formbricks.com/signup",
"headline": {
"default": "Thank you!"
},
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": {
"default": "We appreciate your feedback."
},
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": false,
"fieldIds": []
},
"isVerifyEmailEnabled": false,
"languages": [],
"name": "Example Survey",
"pin": null,
"productOverwrites": null,
"questions": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": null,
"redirectUrl": null,
"segmentId": null,
"showLanguageSwitch": null,
"singleUse": {
"enabled": false,
"isEncrypted": true
},
"status": "inProgress",
"styling": null,
"surveyClosedMessage": null,
"triggers": [],
"type": "link",
"welcomeCard": {
"enabled": true,
"fileUrl": "",
"headline": {
"default": "Welcome!"
},
"html": {
"default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>"
},
"showResponseCount": false,
"timeToFinish": false
},
"workspaceId": "{{workspaceId}}"
}
EOFimport requests
url = "https://{baseurl}/api/v1/management/surveys"
payload = {
"autoClose": None,
"autoComplete": None,
"autoSelectLanguage": None,
"createdBy": None,
"delay": 0,
"displayLimit": None,
"displayOption": "displayOnce",
"displayPercentage": None,
"endings": [
{
"buttonLabel": { "default": "Create your own Survey" },
"buttonLink": "https://formbricks.com/signup",
"headline": { "default": "Thank you!" },
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": { "default": "We appreciate your feedback." },
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": False,
"fieldIds": []
},
"isVerifyEmailEnabled": False,
"languages": [],
"name": "Example Survey",
"pin": None,
"productOverwrites": None,
"questions": [
{
"headline": { "default": "What would you like to know?" },
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": { "default": "Type your answer here..." },
"required": True,
"subheader": { "default": "This is an example survey." },
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": { "default": "Sun ☀️" }
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": { "default": "Ocean 🌊" }
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": { "default": "Palms 🌴" }
}
],
"headline": { "default": "What's important on vacay?" },
"id": "awkn2llljy7a4oulp5t15yec",
"required": True,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": None,
"redirectUrl": None,
"segmentId": None,
"showLanguageSwitch": None,
"singleUse": {
"enabled": False,
"isEncrypted": True
},
"status": "inProgress",
"styling": None,
"surveyClosedMessage": None,
"triggers": [],
"type": "link",
"welcomeCard": {
"enabled": True,
"fileUrl": "",
"headline": { "default": "Welcome!" },
"html": { "default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>" },
"showResponseCount": False,
"timeToFinish": False
},
"workspaceId": "{{workspaceId}}"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
autoClose: null,
autoComplete: null,
autoSelectLanguage: null,
createdBy: null,
delay: 0,
displayLimit: null,
displayOption: 'displayOnce',
displayPercentage: null,
endings: [
{
buttonLabel: {default: 'Create your own Survey'},
buttonLink: 'https://formbricks.com/signup',
headline: {default: 'Thank you!'},
id: 'p73t62dgwq0cvmtt6ug0hmfc',
subheader: {default: 'We appreciate your feedback.'},
type: 'endScreen'
}
],
hiddenFields: {enabled: false, fieldIds: []},
isVerifyEmailEnabled: false,
languages: [],
name: 'Example Survey',
pin: null,
productOverwrites: null,
questions: [
{
headline: {default: 'What would you like to know?'},
id: 'ovpy6va1hab7fl12n913zua0',
inputType: 'text',
placeholder: {default: 'Type your answer here...'},
required: true,
subheader: {default: 'This is an example survey.'},
type: 'openText'
},
{
choices: [
{id: 'xpoxuu3sifk1ee8he67ctf5i', label: {default: 'Sun ☀️'}},
{id: 'hnsovcdmxtcbly6tig1az3qc', label: {default: 'Ocean 🌊'}},
{id: 'kcnelzdxknvwo8fq20d3nrr5', label: {default: 'Palms 🌴'}}
],
headline: {default: 'What\'s important on vacay?'},
id: 'awkn2llljy7a4oulp5t15yec',
required: true,
shuffleOption: 'none',
type: 'multipleChoiceMulti'
}
],
recontactDays: null,
redirectUrl: null,
segmentId: null,
showLanguageSwitch: null,
singleUse: {enabled: false, isEncrypted: true},
status: 'inProgress',
styling: null,
surveyClosedMessage: null,
triggers: [],
type: 'link',
welcomeCard: {
enabled: true,
fileUrl: '',
headline: {default: 'Welcome!'},
html: {
default: '<p class="fb-editor-paragraph" dir="ltr"><span style="white-space: pre-wrap;">Thanks for providing your feedback - let\'s go!</span></p>'
},
showResponseCount: false,
timeToFinish: false
},
workspaceId: '{{workspaceId}}'
})
};
fetch('https://{baseurl}/api/v1/management/surveys', 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://{baseurl}/api/v1/management/surveys",
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([
'autoClose' => null,
'autoComplete' => null,
'autoSelectLanguage' => null,
'createdBy' => null,
'delay' => 0,
'displayLimit' => null,
'displayOption' => 'displayOnce',
'displayPercentage' => null,
'endings' => [
[
'buttonLabel' => [
'default' => 'Create your own Survey'
],
'buttonLink' => 'https://formbricks.com/signup',
'headline' => [
'default' => 'Thank you!'
],
'id' => 'p73t62dgwq0cvmtt6ug0hmfc',
'subheader' => [
'default' => 'We appreciate your feedback.'
],
'type' => 'endScreen'
]
],
'hiddenFields' => [
'enabled' => false,
'fieldIds' => [
]
],
'isVerifyEmailEnabled' => false,
'languages' => [
],
'name' => 'Example Survey',
'pin' => null,
'productOverwrites' => null,
'questions' => [
[
'headline' => [
'default' => 'What would you like to know?'
],
'id' => 'ovpy6va1hab7fl12n913zua0',
'inputType' => 'text',
'placeholder' => [
'default' => 'Type your answer here...'
],
'required' => true,
'subheader' => [
'default' => 'This is an example survey.'
],
'type' => 'openText'
],
[
'choices' => [
[
'id' => 'xpoxuu3sifk1ee8he67ctf5i',
'label' => [
'default' => 'Sun ☀️'
]
],
[
'id' => 'hnsovcdmxtcbly6tig1az3qc',
'label' => [
'default' => 'Ocean 🌊'
]
],
[
'id' => 'kcnelzdxknvwo8fq20d3nrr5',
'label' => [
'default' => 'Palms 🌴'
]
]
],
'headline' => [
'default' => 'What\'s important on vacay?'
],
'id' => 'awkn2llljy7a4oulp5t15yec',
'required' => true,
'shuffleOption' => 'none',
'type' => 'multipleChoiceMulti'
]
],
'recontactDays' => null,
'redirectUrl' => null,
'segmentId' => null,
'showLanguageSwitch' => null,
'singleUse' => [
'enabled' => false,
'isEncrypted' => true
],
'status' => 'inProgress',
'styling' => null,
'surveyClosedMessage' => null,
'triggers' => [
],
'type' => 'link',
'welcomeCard' => [
'enabled' => true,
'fileUrl' => '',
'headline' => [
'default' => 'Welcome!'
],
'html' => [
'default' => '<p class="fb-editor-paragraph" dir="ltr"><span style="white-space: pre-wrap;">Thanks for providing your feedback - let\'s go!</span></p>'
],
'showResponseCount' => false,
'timeToFinish' => false
],
'workspaceId' => '{{workspaceId}}'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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://{baseurl}/api/v1/management/surveys"
payload := strings.NewReader("{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.post("https://{baseurl}/api/v1/management/surveys")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseurl}/api/v1/management/surveys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"autoClose": null,
"autoComplete": null,
"autoSelectLanguage": null,
"blocks": [
{
"elements": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
}
],
"id": "qp8j2k0fx3m9wd1c7b5n4tva",
"name": "Block 1"
},
{
"elements": [
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"id": "rk4v9m2dqz7n0fyt8c3b1xws",
"name": "Block 2"
}
],
"createdAt": "2024-08-05T11:08:27.042Z",
"createdBy": "clfv1zvij0000ru0gunwpy43a",
"delay": 0,
"displayLimit": null,
"displayOption": "displayOnce",
"displayPercentage": null,
"endings": [
{
"buttonLabel": {
"default": "Create your own Survey"
},
"buttonLink": "https://formbricks.com/signup",
"headline": {
"default": "Thank you!"
},
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": {
"default": "We appreciate your feedback."
},
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": false,
"fieldIds": []
},
"id": "clzgw1k4i0001mny1unf8eggn",
"isVerifyEmailEnabled": false,
"languages": [],
"name": "Example Survey",
"pin": null,
"productOverwrites": null,
"questions": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": null,
"redirectUrl": null,
"segment": null,
"showLanguageSwitch": null,
"singleUse": {
"enabled": false,
"isEncrypted": true
},
"status": "inProgress",
"styling": null,
"surveyClosedMessage": null,
"triggers": [],
"type": "link",
"updatedAt": "2024-08-05T11:09:21.826Z",
"welcomeCard": {
"enabled": true,
"fileUrl": "",
"headline": {
"default": "Welcome!"
},
"html": {
"default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>"
},
"showResponseCount": false,
"timeToFinish": false
},
"workspaceId": "clygwxsbh01v5aga1sdien2th"
}
}{
"code": "bad_request",
"details": {
"hiddenFields.enabled": "Required"
},
"message": "Fields are missing or incorrectly formatted"
}Management API - Survey
Create Survey
Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We’d however recommend you to do this via our Formbricks App with the UI for a better visual experience.
POST
/
api
/
v1
/
management
/
surveys
Create Survey
curl --request POST \
--url https://{baseurl}/api/v1/management/surveys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data @- <<EOF
{
"autoClose": null,
"autoComplete": null,
"autoSelectLanguage": null,
"createdBy": null,
"delay": 0,
"displayLimit": null,
"displayOption": "displayOnce",
"displayPercentage": null,
"endings": [
{
"buttonLabel": {
"default": "Create your own Survey"
},
"buttonLink": "https://formbricks.com/signup",
"headline": {
"default": "Thank you!"
},
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": {
"default": "We appreciate your feedback."
},
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": false,
"fieldIds": []
},
"isVerifyEmailEnabled": false,
"languages": [],
"name": "Example Survey",
"pin": null,
"productOverwrites": null,
"questions": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": null,
"redirectUrl": null,
"segmentId": null,
"showLanguageSwitch": null,
"singleUse": {
"enabled": false,
"isEncrypted": true
},
"status": "inProgress",
"styling": null,
"surveyClosedMessage": null,
"triggers": [],
"type": "link",
"welcomeCard": {
"enabled": true,
"fileUrl": "",
"headline": {
"default": "Welcome!"
},
"html": {
"default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>"
},
"showResponseCount": false,
"timeToFinish": false
},
"workspaceId": "{{workspaceId}}"
}
EOFimport requests
url = "https://{baseurl}/api/v1/management/surveys"
payload = {
"autoClose": None,
"autoComplete": None,
"autoSelectLanguage": None,
"createdBy": None,
"delay": 0,
"displayLimit": None,
"displayOption": "displayOnce",
"displayPercentage": None,
"endings": [
{
"buttonLabel": { "default": "Create your own Survey" },
"buttonLink": "https://formbricks.com/signup",
"headline": { "default": "Thank you!" },
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": { "default": "We appreciate your feedback." },
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": False,
"fieldIds": []
},
"isVerifyEmailEnabled": False,
"languages": [],
"name": "Example Survey",
"pin": None,
"productOverwrites": None,
"questions": [
{
"headline": { "default": "What would you like to know?" },
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": { "default": "Type your answer here..." },
"required": True,
"subheader": { "default": "This is an example survey." },
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": { "default": "Sun ☀️" }
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": { "default": "Ocean 🌊" }
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": { "default": "Palms 🌴" }
}
],
"headline": { "default": "What's important on vacay?" },
"id": "awkn2llljy7a4oulp5t15yec",
"required": True,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": None,
"redirectUrl": None,
"segmentId": None,
"showLanguageSwitch": None,
"singleUse": {
"enabled": False,
"isEncrypted": True
},
"status": "inProgress",
"styling": None,
"surveyClosedMessage": None,
"triggers": [],
"type": "link",
"welcomeCard": {
"enabled": True,
"fileUrl": "",
"headline": { "default": "Welcome!" },
"html": { "default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>" },
"showResponseCount": False,
"timeToFinish": False
},
"workspaceId": "{{workspaceId}}"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
autoClose: null,
autoComplete: null,
autoSelectLanguage: null,
createdBy: null,
delay: 0,
displayLimit: null,
displayOption: 'displayOnce',
displayPercentage: null,
endings: [
{
buttonLabel: {default: 'Create your own Survey'},
buttonLink: 'https://formbricks.com/signup',
headline: {default: 'Thank you!'},
id: 'p73t62dgwq0cvmtt6ug0hmfc',
subheader: {default: 'We appreciate your feedback.'},
type: 'endScreen'
}
],
hiddenFields: {enabled: false, fieldIds: []},
isVerifyEmailEnabled: false,
languages: [],
name: 'Example Survey',
pin: null,
productOverwrites: null,
questions: [
{
headline: {default: 'What would you like to know?'},
id: 'ovpy6va1hab7fl12n913zua0',
inputType: 'text',
placeholder: {default: 'Type your answer here...'},
required: true,
subheader: {default: 'This is an example survey.'},
type: 'openText'
},
{
choices: [
{id: 'xpoxuu3sifk1ee8he67ctf5i', label: {default: 'Sun ☀️'}},
{id: 'hnsovcdmxtcbly6tig1az3qc', label: {default: 'Ocean 🌊'}},
{id: 'kcnelzdxknvwo8fq20d3nrr5', label: {default: 'Palms 🌴'}}
],
headline: {default: 'What\'s important on vacay?'},
id: 'awkn2llljy7a4oulp5t15yec',
required: true,
shuffleOption: 'none',
type: 'multipleChoiceMulti'
}
],
recontactDays: null,
redirectUrl: null,
segmentId: null,
showLanguageSwitch: null,
singleUse: {enabled: false, isEncrypted: true},
status: 'inProgress',
styling: null,
surveyClosedMessage: null,
triggers: [],
type: 'link',
welcomeCard: {
enabled: true,
fileUrl: '',
headline: {default: 'Welcome!'},
html: {
default: '<p class="fb-editor-paragraph" dir="ltr"><span style="white-space: pre-wrap;">Thanks for providing your feedback - let\'s go!</span></p>'
},
showResponseCount: false,
timeToFinish: false
},
workspaceId: '{{workspaceId}}'
})
};
fetch('https://{baseurl}/api/v1/management/surveys', 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://{baseurl}/api/v1/management/surveys",
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([
'autoClose' => null,
'autoComplete' => null,
'autoSelectLanguage' => null,
'createdBy' => null,
'delay' => 0,
'displayLimit' => null,
'displayOption' => 'displayOnce',
'displayPercentage' => null,
'endings' => [
[
'buttonLabel' => [
'default' => 'Create your own Survey'
],
'buttonLink' => 'https://formbricks.com/signup',
'headline' => [
'default' => 'Thank you!'
],
'id' => 'p73t62dgwq0cvmtt6ug0hmfc',
'subheader' => [
'default' => 'We appreciate your feedback.'
],
'type' => 'endScreen'
]
],
'hiddenFields' => [
'enabled' => false,
'fieldIds' => [
]
],
'isVerifyEmailEnabled' => false,
'languages' => [
],
'name' => 'Example Survey',
'pin' => null,
'productOverwrites' => null,
'questions' => [
[
'headline' => [
'default' => 'What would you like to know?'
],
'id' => 'ovpy6va1hab7fl12n913zua0',
'inputType' => 'text',
'placeholder' => [
'default' => 'Type your answer here...'
],
'required' => true,
'subheader' => [
'default' => 'This is an example survey.'
],
'type' => 'openText'
],
[
'choices' => [
[
'id' => 'xpoxuu3sifk1ee8he67ctf5i',
'label' => [
'default' => 'Sun ☀️'
]
],
[
'id' => 'hnsovcdmxtcbly6tig1az3qc',
'label' => [
'default' => 'Ocean 🌊'
]
],
[
'id' => 'kcnelzdxknvwo8fq20d3nrr5',
'label' => [
'default' => 'Palms 🌴'
]
]
],
'headline' => [
'default' => 'What\'s important on vacay?'
],
'id' => 'awkn2llljy7a4oulp5t15yec',
'required' => true,
'shuffleOption' => 'none',
'type' => 'multipleChoiceMulti'
]
],
'recontactDays' => null,
'redirectUrl' => null,
'segmentId' => null,
'showLanguageSwitch' => null,
'singleUse' => [
'enabled' => false,
'isEncrypted' => true
],
'status' => 'inProgress',
'styling' => null,
'surveyClosedMessage' => null,
'triggers' => [
],
'type' => 'link',
'welcomeCard' => [
'enabled' => true,
'fileUrl' => '',
'headline' => [
'default' => 'Welcome!'
],
'html' => [
'default' => '<p class="fb-editor-paragraph" dir="ltr"><span style="white-space: pre-wrap;">Thanks for providing your feedback - let\'s go!</span></p>'
],
'showResponseCount' => false,
'timeToFinish' => false
],
'workspaceId' => '{{workspaceId}}'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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://{baseurl}/api/v1/management/surveys"
payload := strings.NewReader("{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.post("https://{baseurl}/api/v1/management/surveys")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseurl}/api/v1/management/surveys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoClose\": null,\n \"autoComplete\": null,\n \"autoSelectLanguage\": null,\n \"createdBy\": null,\n \"delay\": 0,\n \"displayLimit\": null,\n \"displayOption\": \"displayOnce\",\n \"displayPercentage\": null,\n \"endings\": [\n {\n \"buttonLabel\": {\n \"default\": \"Create your own Survey\"\n },\n \"buttonLink\": \"https://formbricks.com/signup\",\n \"headline\": {\n \"default\": \"Thank you!\"\n },\n \"id\": \"p73t62dgwq0cvmtt6ug0hmfc\",\n \"subheader\": {\n \"default\": \"We appreciate your feedback.\"\n },\n \"type\": \"endScreen\"\n }\n ],\n \"hiddenFields\": {\n \"enabled\": false,\n \"fieldIds\": []\n },\n \"isVerifyEmailEnabled\": false,\n \"languages\": [],\n \"name\": \"Example Survey\",\n \"pin\": null,\n \"productOverwrites\": null,\n \"questions\": [\n {\n \"headline\": {\n \"default\": \"What would you like to know?\"\n },\n \"id\": \"ovpy6va1hab7fl12n913zua0\",\n \"inputType\": \"text\",\n \"placeholder\": {\n \"default\": \"Type your answer here...\"\n },\n \"required\": true,\n \"subheader\": {\n \"default\": \"This is an example survey.\"\n },\n \"type\": \"openText\"\n },\n {\n \"choices\": [\n {\n \"id\": \"xpoxuu3sifk1ee8he67ctf5i\",\n \"label\": {\n \"default\": \"Sun ☀️\"\n }\n },\n {\n \"id\": \"hnsovcdmxtcbly6tig1az3qc\",\n \"label\": {\n \"default\": \"Ocean 🌊\"\n }\n },\n {\n \"id\": \"kcnelzdxknvwo8fq20d3nrr5\",\n \"label\": {\n \"default\": \"Palms 🌴\"\n }\n }\n ],\n \"headline\": {\n \"default\": \"What's important on vacay?\"\n },\n \"id\": \"awkn2llljy7a4oulp5t15yec\",\n \"required\": true,\n \"shuffleOption\": \"none\",\n \"type\": \"multipleChoiceMulti\"\n }\n ],\n \"recontactDays\": null,\n \"redirectUrl\": null,\n \"segmentId\": null,\n \"showLanguageSwitch\": null,\n \"singleUse\": {\n \"enabled\": false,\n \"isEncrypted\": true\n },\n \"status\": \"inProgress\",\n \"styling\": null,\n \"surveyClosedMessage\": null,\n \"triggers\": [],\n \"type\": \"link\",\n \"welcomeCard\": {\n \"enabled\": true,\n \"fileUrl\": \"\",\n \"headline\": {\n \"default\": \"Welcome!\"\n },\n \"html\": {\n \"default\": \"<p class=\\\"fb-editor-paragraph\\\" dir=\\\"ltr\\\"><span style=\\\"white-space: pre-wrap;\\\">Thanks for providing your feedback - let's go!</span></p>\"\n },\n \"showResponseCount\": false,\n \"timeToFinish\": false\n },\n \"workspaceId\": \"{{workspaceId}}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"autoClose": null,
"autoComplete": null,
"autoSelectLanguage": null,
"blocks": [
{
"elements": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
}
],
"id": "qp8j2k0fx3m9wd1c7b5n4tva",
"name": "Block 1"
},
{
"elements": [
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"id": "rk4v9m2dqz7n0fyt8c3b1xws",
"name": "Block 2"
}
],
"createdAt": "2024-08-05T11:08:27.042Z",
"createdBy": "clfv1zvij0000ru0gunwpy43a",
"delay": 0,
"displayLimit": null,
"displayOption": "displayOnce",
"displayPercentage": null,
"endings": [
{
"buttonLabel": {
"default": "Create your own Survey"
},
"buttonLink": "https://formbricks.com/signup",
"headline": {
"default": "Thank you!"
},
"id": "p73t62dgwq0cvmtt6ug0hmfc",
"subheader": {
"default": "We appreciate your feedback."
},
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": false,
"fieldIds": []
},
"id": "clzgw1k4i0001mny1unf8eggn",
"isVerifyEmailEnabled": false,
"languages": [],
"name": "Example Survey",
"pin": null,
"productOverwrites": null,
"questions": [
{
"headline": {
"default": "What would you like to know?"
},
"id": "ovpy6va1hab7fl12n913zua0",
"inputType": "text",
"placeholder": {
"default": "Type your answer here..."
},
"required": true,
"subheader": {
"default": "This is an example survey."
},
"type": "openText"
},
{
"choices": [
{
"id": "xpoxuu3sifk1ee8he67ctf5i",
"label": {
"default": "Sun ☀️"
}
},
{
"id": "hnsovcdmxtcbly6tig1az3qc",
"label": {
"default": "Ocean 🌊"
}
},
{
"id": "kcnelzdxknvwo8fq20d3nrr5",
"label": {
"default": "Palms 🌴"
}
}
],
"headline": {
"default": "What's important on vacay?"
},
"id": "awkn2llljy7a4oulp5t15yec",
"required": true,
"shuffleOption": "none",
"type": "multipleChoiceMulti"
}
],
"recontactDays": null,
"redirectUrl": null,
"segment": null,
"showLanguageSwitch": null,
"singleUse": {
"enabled": false,
"isEncrypted": true
},
"status": "inProgress",
"styling": null,
"surveyClosedMessage": null,
"triggers": [],
"type": "link",
"updatedAt": "2024-08-05T11:09:21.826Z",
"welcomeCard": {
"enabled": true,
"fileUrl": "",
"headline": {
"default": "Welcome!"
},
"html": {
"default": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span style=\"white-space: pre-wrap;\">Thanks for providing your feedback - let's go!</span></p>"
},
"showResponseCount": false,
"timeToFinish": false
},
"workspaceId": "clygwxsbh01v5aga1sdien2th"
}
}{
"code": "bad_request",
"details": {
"hiddenFields.enabled": "Required"
},
"message": "Fields are missing or incorrectly formatted"
}Headers
Body
application/json
Available options:
draft, inProgress, paused, completed Available options:
link, app Available options:
displayOnce, displayMultiple, respondMultiple, displaySome Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
The response is of type object.
Was this page helpful?