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