POST /v1/survey/{surveyId}/settings/update

Servers

Path parameters

Name Type Required Description
surveyId Integer Yes

Survey ID

Request headers

Name Type Required Description
Accept String No

e.g. application/json

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
api_key String Yes

Partner specific API key provided by Birdeye for data exchange.

businessId String Yes

Id of the Business.

Request body fields

Name Type Required Description
accessControl Object No

Access control data.

accessControl.userAccessList[] Array No
accessControl.surveyAccess Object No
accessControl.surveyAccess.role String No

User's survey access.

surveySettings Object No

Survey settings

surveySettings.subject String No

Subject of the survey email.

surveySettings.signature String No

Signature.

surveySettings.showQuestionNumber Boolean No

Pass true if want to show question number.

surveySettings.customTitle String No

Custom title value.

surveySettings.themeTextColor String No

Theme color text value.

surveySettings.enableThankyouEmail Boolean No

Pass true if want to enable Thank you email.

surveySettings.showProgressBar Boolean No

Pass true if want to show progress bar.

surveySettings.showLogo String No

Pass ON if want to show logo.

surveySettings.message String No

Thank you message..

surveySettings.progressbarPosition String No

Position of progress bar.

surveySettings.showSurveyTitle Boolean No

Pass true if want to show survey title.

surveySettings.showTitle String No

Show title.

surveySettings.themeColor String No

Theme color value.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.