POST/api/v1/forms/{id}/actions/submit

Submit contact details through a form

Submits contact details through a form, creating or updating a contact and potentially starting the Double-Opt-In process. Provide the contact's email; you can also supply status, first_name, last_name, external_id, and custom data. API submissions do not require a CAPTCHA, even when the form has captcha_required enabled.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The identifier of the form to submit.

Optional contact details supplied under data; include the required email address.

dataobjectoptional
Custom data fields to associate with the contact.

2 status codes
200Returns the contact, including its custom data, email, external identifier, name, identifier, timestamps, and status.
dataobjectoptional
202Returns a Double-Opt-In response indicating whether Double-Opt-In is required.
dataobjectoptional

Error handling

The id path parameter identifies the form to submit. email is required, and status, if supplied, must be active, unsubscribed, or unreachable.