SDK method
tools.createAudience
Create audience. Convenience alias for create_audience, forwarding to tinbox.api.audiences.create.mutate.
Signature
ts
createAudience(input: Parameters<TinboxTools["createAudience"]>[0]): ReturnType<TinboxTools["createAudience"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | The audience (list) name, e.g. 'Newsletter'. |
fromName | string | no | Default sender name for campaigns to this list. |
fromEmail | string | no | Default sender email. |
replyTo | string | no | Default reply-to address. |
doubleOptin | boolean | no | Require subscribers to confirm via email (default off). |
Returns
ReturnType<TinboxTools["createAudience"]>
Example
ts
await tinbox.tools.createAudience({
"name": "<name>"
});