Formbricks Open source Forms & Surveys Logo

API

API: Update submission

POST
http://localhost:300/api/capture/forms/{formId}/submissions/{submissionId}
Update an existing submission in a form by form ID.

Parameters

Query

apiKey
string
Your API key

Body

customer
JSON
The customer and metadata you want to link the submission to.
customer.email

*

email
Customer or user email. This is the primary key to identify users
customer.prop
string
Pass value to create user property. You can filter / create cohorts for future surveys based on props.
data
JSON
The content of the submission.
data.fieldName

*

string
Add value to input field by name.
finished
boolean
Determines if submission is marked as complete.

Body Example

{
  "data": {
  "country": "Germany",
  },
  "customer": {
    "email": "hola@formbricks.com", // required
    "country": "Germany"
  },
  "finished": true
}

Responses

 
200
success
field namerequireddefaultdescription
datayes-The submission object (answers to the form/survey)
customerno-The customer this submission is connected to. The customer object must contain an email field. All other fields are optional and get saved as user properties.
finishednofalseMark a submission as complete to be able to filter accordingly

Need help?

Join our Discord and ask away. We're happy to help where we can!

Join Discord
Previous
Create Submission