Skip to main content
POST
Create a response

Authorizations

x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Body

application/json

The response to create

surveyId
string
required

The ID of the survey

finished
boolean
required

Whether the response is finished

Example:

true

data
object
required

The data of the response

Example:
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"

displayId
string | null

The display ID of the response

singleUseId
string | null

The single use ID of the response

endingId
string | null

The ID of the ending

language
string | null

The language of the response

Example:

"en"

variables
object

The variables of the response

Example:
ttc
object

The TTC of the response

Example:
meta
object

The meta data of the response

Example:
userId
string

Response

201 - application/json

Response created 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

Example:
variables
object

The variables of the response

Example:
ttc
object

The TTC of the response

Example:
meta
object

The meta data of the response

Example:
contactAttributes
object | null

The attributes of the contact

Example:
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