Skip to content
ExtensionsStorefronts
storefronts / Forms
POST/api/projects/{project_id}/forms

Create Form

Creates a form for the target project.

GETPOST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.

Headers

No header metadata is available for this operation.

Path Parameters

NameRequiredTypeDetails
project_idYesNot specified
Description: Target project identifier.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: CreateFormPayload

FieldRequiredTypeDetails
nameYesstring
Description: Display name.
typeYesstring
Description: Text value.
descriptionNostring
Description: Long-form description text.
fieldsNoJSON
Description: JSON object.
layoutNoJSON
Description: JSON object.
settingsNoJSON
Description: JSON object.
formKeyNostring
Description: Text value.

Response Body

Example 200 response

json
{
  "id": 1,
  "project_id": 1,
  "name": "Example",
  "type": "string",
  "description": "string",
  "fields": {},
  "layout": {},
  "settings": {},
  "formKey": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

Errors

400 BAD_REQUEST500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified