SDK method
tools.scheduleCampaign
Schedule campaign. Convenience alias for schedule_campaign, forwarding to tinbox.api.campaigns.schedule.mutate.
Signature
ts
scheduleCampaign(input: Parameters<TinboxTools["scheduleCampaign"]>[0]): ReturnType<TinboxTools["scheduleCampaign"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | The campaign id. |
sendAt | number | yes | Unix timestamp in milliseconds for when to send (must be in the future). |
Returns
ReturnType<TinboxTools["scheduleCampaign"]>
Example
ts
await tinbox.tools.scheduleCampaign({
"id": "<id>",
"sendAt": 0
});