API ReferenceForms
Submit a response to a published form
If the form has double opt-in enabled and the submitted email is a new or previously-unsubscribed contact, the contact is created as pending and a confirmation email is sent — they're not subscribed until they click it. Existing subscribed contacts and forms without double opt-in subscribe immediately.
Authorization
api-key X-API-Key<token>
In: header
Path Parameters
id*string
Form UUID
Request Body
application/json
Field values keyed by field ID, plus optional submission metadata. Field IDs and required fields (including consent) vary per form — see the form's own field schema.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/public/forms/string/submit" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "firstName": "Jane", "utmSource": "newsletter" }'{ "data": { "success": true, "contactId": "8f14e45f-..." }}