Formbricks Open source Forms & Surveys Logo

API

API: Update schema

POST
http://localhost:300/api/capture/forms/{formId}/submissions/schema
Update the schema of a form in Formbricks.

Parameters

Query

apiKey
string
Your API key

Body

pages
List of JSON
Array of all pages of the form.
pages[].id
string
Unique page ID.
pages[].elements
List of JSON
Array of all input elements of this page.
pages[].elements[].id
string
Unique input ID.
pages[].elements[].name
string
Field name.
pages[].elements[].type
string
Input type.
pages[].elements[].label
string
Input label, usually a question.

Body Example

{
  "pages": 
	 [{
	   "id": "emailPage",
	   "elements": 
        [{
        "id": "email",
        "name": "email",
        "type": "text",
        "label": "What's your email address?",
	 	}]
	 }]
}

Responses

 
200
success

Need help?

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

Join Discord
Previous
Update Submission