SDK method
audiences.addContact
POST /audiences/:id/contactstrusted backend insert/subscribe.
Signature
ts
addContact(input: AddContactInput): Promise<AddContactResponse>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
audienceId | string | yes | Target audience id (`aud_…`). |
email | string | yes | The contact's email address. |
name | string | no | Optional display name. |
status | "subscribed" | "pending" | "unsubscribed" | "transactional" | no | The membership status to set; trusted inserts default server-side to subscribed. |
mergeFields | Record<string, string> | no | Per-audience merge-field values, keyed by merge tag. |
Returns
Promise<AddContactResponse>
Example
ts
await tinbox.audiences.addContact({ audienceId: "aud_…", email: "ada@example.com", status: "subscribed" });