Submit a Form

post/public/v1/forms/{form}/submissions

Records a submission of the form. Answers are validated exactly as the app validates them. By default no notification, confirmation email or webhook is sent; set notification_behaviour to send to send them as a submission in the app would. Upload each file first with Create a temporary upload, then answer a file field with [{"temporary_upload_id": "<id>"}]. Send money answers in cents; the response, like List form submissions, shows them in dollars.

post/public/v1/forms/{form}/submissions

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/forms/{form}/submissions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "submitted_url": "https://example.com",
  "form_submission_request_id": "string",
  "form_fields": [
    {
      "field_id": "string",
      "value": "string"
    }
  ],
  "associables": [
    {
      "type": "participant",
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
    }
  ],
  "submitted_at": "string",
  "notification_behaviour": "none",
  "submitted_by": "string"
}'

Response

{
  "data": {
    "id": "f0s1u2b3-a4b5-46c7-8d9e-0f1a2b3c4d5e",
    "submitted_url": "https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "submitted_at": "2024-01-15T10:30:00+00:00",
    "archived_at": null,
    "created_at": "2024-01-15T10:30:00+00:00",
    "form": {
      "id": "f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e"
    },
    "submitted_by": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "first_name": "John",
      "last_name": "Doe"
    },
    "fields": [
      {
        "id": "f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "label": "Date of birth",
        "content": "Section heading or rich text content",
        "type": "date",
        "fillable": true
      }
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

formstringrequired
The form UUID

Body

application/json

submitted_urlstring<uri> | null
form_submission_request_idstring | null
form_fieldsobject[]requiredmin items 1max items 500
▶Show 2 child attributesHide child attributes
- field_idstringrequired
- valuestring
associablesobject[] | nullmax items 10
▶Show 2 child attributesHide child attributes
- typeenum<string>
  Available options:participantshiftsiteuser
- idstring<uuid>
submitted_atstring | null
notification_behaviourenum<string> | null
Available options:nonesend
submitted_bystring | null

Response

200application/json

FormSubmissionResource

dataobjectrequired
▶Show 8 child attributesHide child attributes
- idstringrequired
  Example:f0s1u2b3-a4b5-46c7-8d9e-0f1a2b3c4d5e
- submitted_urlstring | nullrequired
  Example:https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- submitted_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- archived_atstring | nullrequired
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- formobjectrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- submitted_byobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  first_namestringrequired
  Example:John
  last_namestringrequired
  Example:Doe
- fieldsobject[]required
  ▶Show 7 child attributesHide child attributes
  idstringrequired
  Example:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  labelstring | nullrequired
  Example:Date of birth
  contentstring | nullrequired
  Example:Section heading or rich text content
  typestringrequired
  Example:date
  fillablebooleanrequired
  Example:true
  valueanyrequired
  display_valueanyrequired

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error