SDK method
forms.capture
POST /forms/:slug`POST /forms/:slug` (JSON) — capture a lead into the form's audience.
Signature
ts
capture(input: CaptureLeadInput): Promise<CaptureLeadResponse>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
formSlug | string | yes | The hosted form's URL slug (`/forms/<slug>`). |
email | string | yes | The subscriber's email address. |
mergeFields | Record<string, string> | no | Per-form merge-field values, keyed by merge tag (`{ FNAME: "Ada" }`). |
hp | string | no | Honeypot value — leave unset/empty; a bot fills it and the lead is silently dropped. |
Returns
Promise<CaptureLeadResponse>
Example
ts
const pub = new Tinbox({ host: "https://acme.com" });
await pub.forms.capture({ formSlug: "newsletter", email: "ada@example.com" });