SDK method
tools.createSegment
Create a segment. Convenience alias for create_segment, forwarding to tinbox.api.segments.create.mutate.
Signature
ts
createSegment(input: Parameters<TinboxTools["createSegment"]>[0]): ReturnType<TinboxTools["createSegment"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
audienceId | string | yes | The audience the segment belongs to. |
name | string | yes | A name for the segment. |
type | "saved" | "static" | no | 'saved' (rule-based, default) or 'static' (manual membership). |
conditions | unknown | no | The rule tree for a saved segment (omit for static). |
Returns
ReturnType<TinboxTools["createSegment"]>
Example
ts
await tinbox.tools.createSegment({
"audienceId": "aud_…",
"name": "<name>"
});