Skip to content

SDK method

tools.activateJourney

Activate journey. Convenience alias for activate_journey, forwarding to tinbox.api.journeys.activate.mutate.

Signature

ts
activateJourney(input: Parameters<TinboxTools["activateJourney"]>[0]): ReturnType<TinboxTools["activateJourney"]>

Parameters

NameTypeRequiredDescription
idstringyesThe journey id.

Returns

ReturnType<TinboxTools["activateJourney"]>

Example

ts
await tinbox.tools.activateJourney({
  "id": "<id>"
});