API v2 Documentation (Draft)
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Client API > File Upload
Roles
Me
Management API > Responses
Management API > Contacts
Management API > Contact Attribute Keys
Management API > Surveys > Contact Links
Management API > Webhooks
Organizations API > Teams
Organizations API > Project Teams
Organizations API > Users
Update a response
Updates a response in the database.
PUT
/
responses
/
{id}
curl --request PUT \
--url https://app.formbricks.com/api/v2/management/responses/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"createdAt": "<string>",
"updatedAt": "<string>",
"environmentId": "<string>",
"surveyId": "<string>",
"userId": "<string>",
"displayId": "<string>",
"singleUseId": "<string>",
"finished": true,
"endingId": "<string>",
"language": "<string>",
"data": {},
"variables": {},
"ttc": {},
"meta": {
"source": "<string>",
"url": "<string>",
"userAgent": {
"browser": "<string>",
"device": "<string>",
"os": "<string>"
},
"country": "<string>",
"action": "<string>"
}
}'
{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"finished": true,
"surveyId": "<string>",
"contactId": "<string>",
"endingId": "<string>",
"data": {
"question1": "answer1",
"question2": 2,
"question3": [
"answer3",
"answer4"
],
"question4": {
"subquestion1": "answer5"
}
},
"variables": {
"variable1": "answer1",
"variable2": 2
},
"ttc": {
"question1": 10,
"question2": 20
},
"meta": {
"source": "https://example.com",
"url": "https://example.com",
"userAgent": {
"browser": "Chrome",
"os": "Windows",
"device": "Desktop"
},
"country": "US",
"action": "click"
},
"contactAttributes": {
"attribute1": "value1",
"attribute2": "value2"
},
"singleUseId": "<string>",
"language": "en",
"displayId": "<string>"
}
Authorizations
Use your Formbricks x-api-key to authenticate.
Path Parameters
The ID of the response
Body
application/json
The response to update
The body is of type object
.
Response
200 - application/json
Response updated successfully.
The response is of type object
.
Was this page helpful?
curl --request PUT \
--url https://app.formbricks.com/api/v2/management/responses/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"createdAt": "<string>",
"updatedAt": "<string>",
"environmentId": "<string>",
"surveyId": "<string>",
"userId": "<string>",
"displayId": "<string>",
"singleUseId": "<string>",
"finished": true,
"endingId": "<string>",
"language": "<string>",
"data": {},
"variables": {},
"ttc": {},
"meta": {
"source": "<string>",
"url": "<string>",
"userAgent": {
"browser": "<string>",
"device": "<string>",
"os": "<string>"
},
"country": "<string>",
"action": "<string>"
}
}'
{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"finished": true,
"surveyId": "<string>",
"contactId": "<string>",
"endingId": "<string>",
"data": {
"question1": "answer1",
"question2": 2,
"question3": [
"answer3",
"answer4"
],
"question4": {
"subquestion1": "answer5"
}
},
"variables": {
"variable1": "answer1",
"variable2": 2
},
"ttc": {
"question1": 10,
"question2": 20
},
"meta": {
"source": "https://example.com",
"url": "https://example.com",
"userAgent": {
"browser": "Chrome",
"os": "Windows",
"device": "Desktop"
},
"country": "US",
"action": "click"
},
"contactAttributes": {
"attribute1": "value1",
"attribute2": "value2"
},
"singleUseId": "<string>",
"language": "en",
"displayId": "<string>"
}