Update a response

Updates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.

PUT /management/responses/{id}

Update a response

cURL

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 '
{
  "finished": true,
  "endingId": "<string>",
  "data": {},
  "variables": {},
  "ttc": {},
  "language": "<string>"
}
'

200

{
  "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

x-api-key · string · header · required

Use your Formbricks x-api-key to authenticate.

Path Parameters

id · string · required

The ID of the response

Body

application/json

The response fields to update

finished · boolean

endingId · string | null

data · object

Show child attributes

variables · object

Show child attributes

ttc · object

Show child attributes

language · string

Response

200 - application/json

Response updated successfully.

id · string

The ID of the response

createdAt · string

The date and time the response was created

Example:

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

updatedAt · string

The date and time the response was last updated

Example:

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

finished · boolean

Whether the response is finished

Example:

true

surveyId · string

The ID of the survey

contactId · string | null

The ID of the contact

endingId · string | null

The ID of the ending

data · object

The data of the response

Show child attributes

Example:

{
  "question1": "answer1",
  "question2": 2,
  "question3": ["answer3", "answer4"],
  "question4": { "subquestion1": "answer5" }
}

variables · object

The variables of the response

Show child attributes

Example:

{ "variable1": "answer1", "variable2": 2 }

ttc · object

The TTC of the response

Show child attributes

Example:

{ "question1": 10, "question2": 20 }

meta · object

The meta data of the response

Show child attributes

Example:

{
  "source": "https://example.com",
  "url": "https://example.com",
  "userAgent": {
    "browser": "Chrome",
    "os": "Windows",
    "device": "Desktop"
  },
  "country": "US",
  "action": "click"
}

contactAttributes · object

The attributes of the contact

Show child attributes

Example:

{
  "attribute1": "value1",
  "attribute2": "value2"
}

singleUseId · string | null

The single use ID of the response

language · string | null

The language of the response

Example:

"en"

displayId · string | null

The display ID of the response