Skip to content

SDK method

tools.sendCampaign

Send campaign now. Convenience alias for send_campaign, forwarding to tinbox.api.campaigns.send.mutate.

Signature

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

Parameters

NameTypeRequiredDescription
idstringyesThe campaign id (must be approved).

Returns

ReturnType<TinboxTools["sendCampaign"]>

Example

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