POST /v1/survey/{survey_id}/submit
Servers
- https://api.birdeye.com/resources
Path parameters
Name | Type | Required | Description |
---|---|---|---|
survey_id |
Integer | Yes |
Id of the Survey. |
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 |
---|---|---|---|
lastModified |
Number | No | |
logoUrl |
String | No | |
name |
String | No | |
created |
Number | No | |
businessId |
Number | No | |
isComplete |
Number | No | |
questionCount |
Number | No | |
status |
String | No | |
responses |
Number | No | |
surveyId |
Number | No | |
pages[] |
Array | No | |
pages[].id |
Number | No | |
pages[].order |
Number | No | |
pages[].name |
String | No | |
pages[].visible |
Boolean | No | |
pages[].questions[] |
Array | No | |
pages[].questions[].showQuestionNumbers |
Number | Yes | |
pages[].questions[].displayLogic[] |
Array | Yes | |
pages[].questions[].choices[] |
Array | Yes | |
pages[].questions[].choices[].id |
Number | Yes | |
pages[].questions[].choices[].order |
Number | Yes | |
pages[].questions[].choices[].title |
String | Yes | |
pages[].questions[].skipQuestion |
Boolean | Yes | |
pages[].questions[].maximumValue |
Number | Yes | |
pages[].questions[].value[] |
Array | Yes | |
pages[].questions[].minimumValue |
Number | Yes | |
pages[].questions[].reactElementId |
Number | Yes | |
pages[].questions[].id |
Number | Yes | |
pages[].questions[].order |
Number | Yes | |
pages[].questions[].name |
String | Yes | |
pages[].questions[].maximumRateDescription |
String | No | |
pages[].questions[].visible |
Boolean | Yes | |
pages[].questions[].isRequired |
Boolean | Yes | |
pages[].questions[].displayQuestion |
Boolean | Yes | |
pages[].questions[].title |
String | Yes | |
pages[].questions[].type |
String | Yes | |
pages[].questions[].minimumRateDescription |
String | No | |
pages[].questions[].rows[] |
Array | Yes | |
pages[].questions[].skipLogic[] |
Array | Yes | |
pages[].showQuestionNumbers |
Number | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.