Skip to main content
POST
/
forms
/
{id}
/
submissions
Create a form submission
curl --request POST \
  --url https://api.heffl.com/api/v2/forms/{id}/submissions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "data": {}
}'
{
  "id": "<string>",
  "number": "<string>",
  "data": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Form ID (frm_ prefix)

Body

application/json
data
object
required

Answers keyed by field key (cf_*). Values must match each field's data type; choice fields accept one of the field's allowed option values.

Response

OK

id
string
required

Submission ID (cor_ prefix)

number
string | null
required

Auto-generated submission number

data
object
required

Answers keyed by field key (cf_*). Values match each field's data type.

createdAt
string<date-time>
required

When the submission was received

updatedAt
string<date-time> | null
required

When the submission was last updated