Create form

Create a new form in the account.

POST
/v1/forms

Authorization

authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

Form params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a form.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/forms" \  -H "Content-Type: application/json" \  -d '{    "fields": [      {        "key": "full_name",        "label": "Full Name",        "position": 0,        "required": true,        "type": "short_text"      }    ],    "internal_name": "Intake Form"  }'
{  "data": {    "created_at": "2025-02-17T17:49:19Z",    "field_count": 1,    "fields": [      {        "description": null,        "id": "ff_abc123",        "key": "full_name",        "label": "Full Name",        "must_be_true": false,        "options": null,        "position": 0,        "required": true,        "sensitive": false,        "type": "short_text"      }    ],    "id": "frm_d025a96ac0c6",    "internal_name": "Intake Form",    "object": "form",    "updated_at": "2025-02-17T17:49:19Z"  }}