EmailBison: Create Campaign Schedule

Set the sending days, hours and timezone for an EmailBison campaign.

Tool ID: emailbison_create_campaign_schedule

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'emailbison_create_campaign_schedule',
  {
    "campaign_id": 123,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true,
    "start_time": "example",
    "end_time": "example",
    "timezone": "America/New_York",
    "save_as_template": true
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute emailbison_create_campaign_schedule --input '{
  "campaign_id": 123,
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": true,
  "sunday": true,
  "start_time": "example",
  "end_time": "example",
  "timezone": "America/New_York",
  "save_as_template": true
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": {
      "id": 123,
      "type": "example",
      "monday": true
    }
  }
}

Use deepline describe emailbison_create_campaign_schedule --json for the latest machine-readable contract.

Input reference

This endpoint allows the authenticated user to create the schedule of the campaign.

Name	Type	Required	Default	Details
`payload.campaign_id`	`integer`	Yes	—	The ID of the campaign.
`payload.monday`	`boolean`	Yes	—	Whether the schedule includes Monday.
`payload.tuesday`	`boolean`	Yes	—	Whether the schedule includes Tuesday.
`payload.wednesday`	`boolean`	Yes	—	Whether the schedule includes Wednesday.
`payload.thursday`	`boolean`	Yes	—	Whether the schedule includes Thursday.
`payload.friday`	`boolean`	Yes	—	Whether the schedule includes Friday.
`payload.saturday`	`boolean`	Yes	—	Whether the schedule includes Saturday.
`payload.sunday`	`boolean`	Yes	—	Whether the schedule includes Sunday.
`payload.start_time`	`string`	Yes	—	The start time in HH:MM format.
`payload.end_time`	`string`	Yes	—	The end time in HH:MM format.
`payload.timezone`	`string`	Yes	—	The timezone of the schedule.
`payload.save_as_template`	`boolean`	Yes	—	Wheter the created schedule should be saved as template.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	—
`result.data.data.id`	`integer`	No	—	—
`result.data.data.type`	`string`	No	—	—
`result.data.data.monday`	`boolean`	No	—	—
`result.data.data.tuesday`	`boolean`	No	—	—
`result.data.data.wednesday`	`boolean`	No	—	—
`result.data.data.thursday`	`boolean`	No	—	—
`result.data.data.friday`	`boolean`	No	—	—
`result.data.data.saturday`	`boolean`	No	—	—
`result.data.data.sunday`	`boolean`	No	—	—
`result.data.data.start_time`	`string`	No	—	—
`result.data.data.end_time`	`string`	No	—	—
`result.data.data.timezone`	`string`	No	—	—
`result.data.data.created_at`	`string`	No	—	—
`result.data.data.updated_at`	`string`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation