PATCH
/v1/forms/{id}Change a form
Any subset of a form's name, description, fields, sections, settings and targetDefinitionKey. Fields, sections and settings REPLACE, whole — send the complete list, not just the line you changed. The SLUG is deliberately not patchable: it is the published address, and changing it would break every link already handed out.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
200application/json
the action's answer
{
"data": {
"createdAt": "string",
"createdBy": "string",
"description": "string",
"fields": [
{
"column": "string",
"documentType": "string",
"entityType": "string",
"id": "",
"kind": "string",
"label": "string",
"options": "string",
"placeholder": "string",
"required": "string"
}
],
"id": "",
"name": "string",
"publishedAt": "string",
"sections": [
{
"fieldIds": "string",
"title": "string"
}
],
"settings": {
"analytics": true,
"automations": [
"string"
],
"branding": "string",
"pacing": "string",
"postSubmit": "string",
"saveDrafts": true,
"signature": "string",
"theme": "string"
},
"slug": "string",
"sourceUrl": "string",
"stats": {
"submissions": 1,
"views": 1
},
"status": "string",
"targetDefinitionKey": "string",
"updatedAt": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired