v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Widgets

Submit saved signup form by company

Compatibility path for saved signup form submissions. New embeds should use /forms/{formId}.

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/{companyIdOrFormId}/{formId}

Path parameters

companyIdOrFormIdstring required

The company ID the form belongs to

formIdstring required

The saved form ID

Request body

emailstring email required

Subscriber email address

firstNamestring
lastNamestring
phonestring

Subscriber phone number in E.164 or US national format, when configured on the saved form. Stored on the base subscriber profile and does not grant SMS consent.

customAttributesobject

Subscriber custom attributes for custom fields configured on the saved form

listIdsstring[]

Ignored for saved forms. Stored form settings are used.

listIds[]string[]

Ignored for saved forms. Stored form settings are used.

tagIdsstring[]

Ignored for saved forms. Stored form settings are used.

tagIds[]string[]

Ignored for saved forms. Stored form settings are used.

duplicateStrategy'skip' | 'merge' | 'overwrite'

Ignored for saved forms. Stored form settings are used.

duplicateStrategyTokenstring

Ignored for saved forms. Stored form settings are used.

redirectUrlstring

Ignored for saved forms. Stored form settings are used.

websitestring

Honeypot field. Leave empty.

Example request

{
  "email": "user@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "phone": "+12133734253",
  "customAttributes": {
    "nickname": "Ace",
    "favorite_fruit": "Mango"
  }
}

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
}