SDK method
tools.updateAudience
Update audience. Convenience alias for update_audience, forwarding to tinbox.api.audiences.update.mutate.
Signature
ts
updateAudience(input: Parameters<TinboxTools["updateAudience"]>[0]): ReturnType<TinboxTools["updateAudience"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | The audience id. |
name | string | no | New list name. |
fromName | string | no | New default sender name. |
fromEmail | string | no | New default sender email. |
replyTo | string | no | New default reply-to. |
doubleOptin | boolean | no | Toggle double opt-in. |
Returns
ReturnType<TinboxTools["updateAudience"]>
Example
ts
await tinbox.tools.updateAudience({
"id": "<id>"
});