Widgets

Submit saved signup form

Submit a saved signup form created in the dashboard. No API key is required.

The form's stored settings are the source of truth for audience targeting (lists, tags) and success behavior (success message or redirect URL), so dashboard edits apply to deployed embeds without re-embedding. List, tag, and redirect values in the request are ignored.

post/forms/{companyId}/{formId}

Path parameters

companyIdstring required

The company ID the form belongs to

formIdstring required

The saved form ID

Request body

emailstring email required

Subscriber email address

firstNamestring
lastNamestring
websitestring

Honeypot field. Leave empty.

Example request

{
  "email": "user@example.com",
  "firstName": "Jane",
  "lastName": "Doe"
}

Response

Form submitted successfully. Native HTML form posts that accept text/html receive a hosted confirmation page showing the form's success message instead of JSON.

successboolean

Example response

{
  "success": true
}

Changes