PUT
/
surveys
/
{id}
curl --request PUT \
  --url https://app.formbricks.com/api/v2/management/surveys/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "redirectUrl": "<string>",
  "type": "link",
  "environmentId": "<string>",
  "questions": [
    "<any>"
  ],
  "endings": [],
  "thankYouCard": {
    "enabled": true,
    "message": "<string>"
  },
  "hiddenFields": {
    "enabled": true,
    "fieldIds": [
      "<string>"
    ]
  },
  "variables": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "value": 0
    }
  ],
  "displayOption": "displayOnce",
  "recontactDays": 123,
  "displayLimit": 123,
  "autoClose": 123,
  "autoComplete": 123,
  "delay": 123,
  "runOnDate": "<string>",
  "closeOnDate": "<string>",
  "singleUse": {
    "enabled": true,
    "isEncrypted": true
  },
  "isVerifyEmailEnabled": true,
  "isSingleResponsePerEmailEnabled": true,
  "inlineTriggers": [
    "<any>"
  ],
  "verifyEmail": {
    "enabled": true,
    "message": "<string>"
  },
  "displayPercentage": 123,
  "welcomeCard": {
    "enabled": true,
    "timeToFinish": true,
    "showResponseCount": true,
    "headline": {},
    "html": {},
    "fileUrl": "<string>",
    "buttonLabel": {},
    "videoUrl": "<string>"
  },
  "surveyClosedMessage": {
    "enabled": true,
    "heading": "<string>",
    "subheading": "<string>"
  },
  "styling": {
    "brandColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "questionColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "inputColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "inputBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardBackgroundColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardShadowColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "highlightBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "isDarkModeEnabled": true,
    "roundness": 123,
    "cardArrangement": {
      "linkSurveys": "casual",
      "appSurveys": "casual"
    },
    "background": {
      "bg": "<string>",
      "bgType": "animation",
      "brightness": 123
    },
    "hideProgressBar": true,
    "isLogoHidden": true
  },
  "projectOverwrites": {
    "brandColor": "<string>",
    "highlightBorderColor": "<string>",
    "placement": "bottomLeft",
    "clickOutsideClose": true,
    "darkOverlay": true
  },
  "showLanguageSwitch": true
}'
{
  "id": "<string>",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "name": "<string>",
  "redirectUrl": "<string>",
  "type": "link",
  "status": "draft",
  "thankYouMessage": "<string>",
  "showLanguageSwitch": true,
  "showThankYouMessage": true,
  "welcomeCard": {
    "enabled": true,
    "timeToFinish": true,
    "showResponseCount": true,
    "headline": {},
    "html": {},
    "fileUrl": "<string>",
    "buttonLabel": {},
    "videoUrl": "<string>"
  },
  "displayProgressBar": true,
  "resultShareKey": "<string>",
  "pin": "<string>",
  "createdBy": "<string>",
  "environmentId": "<string>",
  "endings": [],
  "thankYouCard": {
    "enabled": true,
    "message": "<string>"
  },
  "hiddenFields": {
    "enabled": true,
    "fieldIds": [
      "<string>"
    ]
  },
  "variables": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "value": 0
    }
  ],
  "displayOption": "displayOnce",
  "recontactDays": 123,
  "displayLimit": 123,
  "autoClose": 123,
  "autoComplete": 123,
  "delay": 123,
  "runOnDate": "<string>",
  "closeOnDate": "<string>",
  "surveyClosedMessage": {
    "enabled": true,
    "heading": "<string>",
    "subheading": "<string>"
  },
  "segmentId": "<string>",
  "projectOverwrites": {
    "brandColor": "<string>",
    "highlightBorderColor": "<string>",
    "placement": "bottomLeft",
    "clickOutsideClose": true,
    "darkOverlay": true
  },
  "styling": {
    "brandColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "questionColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "inputColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "inputBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardBackgroundColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "cardShadowColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "highlightBorderColor": {
      "light": "<string>",
      "dark": "<string>"
    },
    "isDarkModeEnabled": true,
    "roundness": 123,
    "cardArrangement": {
      "linkSurveys": "casual",
      "appSurveys": "casual"
    },
    "background": {
      "bg": "<string>",
      "bgType": "animation",
      "brightness": 123
    },
    "hideProgressBar": true,
    "isLogoHidden": true
  },
  "singleUse": {
    "enabled": true,
    "isEncrypted": true
  },
  "isVerifyEmailEnabled": true,
  "isSingleResponsePerEmailEnabled": true,
  "inlineTriggers": [
    "<any>"
  ],
  "isBackButtonHidden": true,
  "verifyEmail": {
    "enabled": true,
    "message": "<string>"
  },
  "displayPercentage": 123,
  "questions": [
    "<any>"
  ]
}

Authorizations

​
x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Path Parameters

​
id
string
required

The ID of the survey

Body

application/json
The survey to update

A survey input object for creating or updating surveys

​
name
string
required

The name of the survey

​
type
enum<string>
required

The type of the survey

Available options:
link,
web,
website,
app
​
environmentId
string
required

The environment ID of the survey

​
questions
any[]
required

The questions of the survey.

​
hiddenFields
object
required

Hidden fields configuration

​
displayOption
enum<string>
required

Display options for the survey

Available options:
displayOnce,
displayMultiple,
displaySome,
respondMultiple
​
delay
number
required

Delay before showing survey

​
singleUse
object
required

Single use configuration

​
isVerifyEmailEnabled
boolean
required

Whether email verification is enabled

​
isSingleResponsePerEmailEnabled
boolean
required

Whether single response per email is enabled

​
welcomeCard
object
required

The welcome card configuration

​
redirectUrl
string | null

The URL to redirect to after the survey is completed

​
endings
object[]

The endings of the survey

​
thankYouCard
object | null

The thank you card of the survey (deprecated)

​
variables
object[]

Survey variables

​
recontactDays
number | null

Days before recontacting

​
displayLimit
number | null

Display limit for the survey

​
autoClose
number | null

Auto close time in seconds

​
autoComplete
number | null

Auto complete time in seconds

​
runOnDate
string | null

Date to run the survey

​
closeOnDate
string | null

Date to close the survey

​
inlineTriggers
any[] | null

Inline triggers configuration

​
verifyEmail
object

Email verification configuration (deprecated)

​
displayPercentage
number | null

The display percentage of the survey

​
surveyClosedMessage
object | null

Message shown when survey is closed

​
styling
object | null

Survey styling configuration

​
projectOverwrites
object | null

Project specific overwrites

​
showLanguageSwitch
boolean | null

Whether to show the language switch

Response

200 - application/json
Response updated successfully.
​
id
string
required

The ID of the survey

​
createdAt
string
required

The date and time the survey was created

Example:

"2021-01-01T00:00:00.000Z"

​
updatedAt
string
required

The date and time the survey was last updated

Example:

"2021-01-01T00:00:00.000Z"

​
name
string
required

The name of the survey

​
redirectUrl
string | null
required

The URL to redirect to after the survey is completed

​
type
enum<string>
required

The type of the survey

Available options:
link,
web,
website,
app
​
status
enum<string>
required

The status of the survey

Available options:
draft,
scheduled,
inProgress,
paused,
completed
​
thankYouMessage
string | null
required

The thank you message of the survey

​
showLanguageSwitch
boolean | null
required

Whether to show the language switch

​
showThankYouMessage
boolean | null
required

Whether to show the thank you message

​
welcomeCard
object
required

The welcome card configuration

​
displayProgressBar
boolean | null
required

Whether to display the progress bar

​
resultShareKey
string | null
required

The result share key of the survey

​
pin
string | null
required

The pin of the survey

​
createdBy
string | null
required

The user who created the survey

​
environmentId
string
required

The environment ID of the survey

​
endings
object[]
required

The endings of the survey

​
thankYouCard
object | null
required

The thank you card of the survey (deprecated)

​
hiddenFields
object
required

Hidden fields configuration

​
variables
object[]
required

Survey variables

​
displayOption
enum<string>
required

Display options for the survey

Available options:
displayOnce,
displayMultiple,
displaySome,
respondMultiple
​
recontactDays
number | null
required

Days before recontacting

​
displayLimit
number | null
required

Display limit for the survey

​
autoClose
number | null
required

Auto close time in seconds

​
autoComplete
number | null
required

Auto complete time in seconds

​
delay
number
required

Delay before showing survey

​
runOnDate
string | null
required

Date to run the survey

​
closeOnDate
string | null
required

Date to close the survey

​
surveyClosedMessage
object | null
required

Message shown when survey is closed

​
segmentId
string | null
required

ID of the segment

​
projectOverwrites
object | null
required

Project specific overwrites

​
styling
object | null
required

Survey styling configuration

​
singleUse
object
required

Single use configuration

​
isVerifyEmailEnabled
boolean
required

Whether email verification is enabled

​
isSingleResponsePerEmailEnabled
boolean
required

Whether single response per email is enabled

​
inlineTriggers
any[] | null
required

Inline triggers configuration

​
isBackButtonHidden
boolean
required

Whether the back button is hidden

​
verifyEmail
object
required

Email verification configuration (deprecated)

​
displayPercentage
number | null
required

The display percentage of the survey

​
questions
any[]
required

The questions of the survey.

Was this page helpful?