Documentation
Difficulty level:
API - Form - POST form/submission/{id}
POST form/submission/{id}
Used for
Push ("inschieten") a form submission server-side from an external application.
The submission runs through the same processing as a web submission: linking to an existing customer based on the email address, and sending the configured confirmation and administrator notification emails.
Saving is intentionally "loose": unknown fields are stored, the form definition is not strictly enforced. When the form has an email field, the format of the value is validated.
Authentication
User must be logged in at administrator level and have the api_form_submission right. The form must belong to the authenticated license.
Parameters
| Parameter | Description | Required | Example |
|---|---|---|---|
| id | Form ID (in the URL) | Yes | 12 |
| <fieldname> | A key/value pair per field. The field names are the field_name values from GET form/{id}. |
Depends on the form | email = jan@example.com |
Example
Push a contact form (id 12) with name, email and message.
POST api/rest/form/submission/12
Request:
{
"name": "Jan Jansen",
"email": "jan@example.com",
"message": "Please send me more information."
}
Response:
{
"result": true,
"message": "submission saved",
"submission_id": 345,
"status": 10
}
