Delete a response

Deletes a response from the database.

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

Response

200 - application/json

Response deleted 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 | null

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