Create form submission

​

Submits data to a form on behalf of a candidate. If no profile exists with the given email address, one is created automatically. If a matching profile already exists, the submission is associated with it.

Use GET /apis/forms/forms/{form_id}/schema to retrieve the correct field names before posting. Note: product choice fields cannot be submitted via the API.

Path Parameters
  • form_id
    Type: string
    required

    Unique identifier of the form.

Body
required
application/json

Additional fields depend on the form schema. Retrieve field names via GET /apis/forms/forms/{form_id}/schema.

  • email
    Type: stringFormat: email
    required

    Email address. Used to match or create a profile.

  • first_name
    Type: string
    required

    First name of the candidate.

  • last_name
    Type: string
    required

    Last name of the candidate.

  • propertyName
    Type: anything
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/apis/forms/forms/{form_id}/submissions
curl https://school.fullfabric.cloud/apis/forms/forms/507f1f77bcf86cd799439011/submissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'FF-Auth: YOUR_SECRET_TOKEN' \
  --data '{
  "first_name": "James",
  "last_name": "Chen",
  "email": "james.chen@example.com",
  "__programme_interest": "MBA Full-Time",
  "__nationality": "Chinese"
}'

{
  "id": "6672d2986ab728050f687af4",
  "submitted_at": 1718801048,
  "first_name": "James",
  "last_name": "Chen",
  "email": "james.chen@example.com",
  "__programme_interest": "MBA Full-Time",
  "__nationality": "Chinese"
}

Successful response.