SDK method
tools.pauseOutreach
Pause outreach campaign. Convenience alias for pause_outreach, forwarding to tinbox.api.outreach.pause.mutate.
Signature
ts
pauseOutreach(input: Parameters<TinboxTools["pauseOutreach"]>[0]): ReturnType<TinboxTools["pauseOutreach"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | The outreach campaign id. |
Returns
ReturnType<TinboxTools["pauseOutreach"]>
Example
ts
await tinbox.tools.pauseOutreach({
"id": "<id>"
});