Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / ScheduleCampaignPayload

Interface: ScheduleCampaignPayload

Defined in: client/src/resources/campaigns/campaigns.types.ts:381

Payload for CampaignsClient.schedule.

Valid combinations:

  • { type: 'now' } — send immediately
  • { type: 'schedule', datetime: '2025-06-15T10:00:00+02:00' } — schedule for later
  • { type: null } — cancel a previously scheduled send (moves back to draft)

Example ​

typescript
// Send now
await client.campaigns.schedule(campaignId, { type: 'now' });

// Schedule for a specific time
await client.campaigns.schedule(campaignId, {
  type: 'schedule',
  datetime: '2025-09-15T09:00:00+02:00',
});

// Cancel scheduled send
await client.campaigns.schedule(campaignId, { type: null });

Properties ​

datetime? ​

optional datetime?: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:389

Target send datetime for type: 'schedule'.

ISO 8601 date-time string (e.g. '2025-09-15T09:00:00+02:00').

type? ​

optional type?: "now" | "schedule" | null

Defined in: client/src/resources/campaigns/campaigns.types.ts:383

Schedule type. null cancels an existing scheduled send.