> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Emailbison Create Campaign Schedule: Inputs, Cost & CLI

> This endpoint allows the authenticated user to create the schedule of the campaign. Includes inputs, outputs, costs, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=emailbison_create_campaign_schedule:{"campaign_id":"{{campaign_id}}","monday":"{{monday}}","tuesday":"{{tuesday}}","wednesday":"{{wednesday}}","thursday":"{{thursday}}","friday":"{{friday}}","saturday":"{{saturday}}","sunday":"{{sunday}}","start_time":"{{start_time}}","end_time":"{{end_time}}","timezone":"{{timezone}}","save_as_template":"{{save_as_template}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                       | Type      | Required | Default | Description                                              |
| -------------------------- | --------- | -------- | ------- | -------------------------------------------------------- |
| `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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "This endpoint allows the authenticated user to create the schedule of the campaign.",
    "properties": {
      "campaign_id": {
        "type": "integer",
        "description": "The ID of the campaign."
      },
      "monday": {
        "type": "boolean",
        "description": "Whether the schedule includes Monday."
      },
      "tuesday": {
        "type": "boolean",
        "description": "Whether the schedule includes Tuesday."
      },
      "wednesday": {
        "type": "boolean",
        "description": "Whether the schedule includes Wednesday."
      },
      "thursday": {
        "type": "boolean",
        "description": "Whether the schedule includes Thursday."
      },
      "friday": {
        "type": "boolean",
        "description": "Whether the schedule includes Friday."
      },
      "saturday": {
        "type": "boolean",
        "description": "Whether the schedule includes Saturday."
      },
      "sunday": {
        "type": "boolean",
        "description": "Whether the schedule includes Sunday."
      },
      "start_time": {
        "type": "string",
        "description": "The start time in HH:MM format."
      },
      "end_time": {
        "type": "string",
        "description": "The end time in HH:MM format."
      },
      "timezone": {
        "type": "string",
        "description": "The timezone of the schedule."
      },
      "save_as_template": {
        "type": "boolean",
        "description": "Wheter the created schedule should be saved as template."
      }
    },
    "required": [
      "campaign_id",
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday",
      "saturday",
      "sunday",
      "start_time",
      "end_time",
      "timezone",
      "save_as_template"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "type": {
                "type": "string"
              },
              "monday": {
                "type": "boolean"
              },
              "tuesday": {
                "type": "boolean"
              },
              "wednesday": {
                "type": "boolean"
              },
              "thursday": {
                "type": "boolean"
              },
              "friday": {
                "type": "boolean"
              },
              "saturday": {
                "type": "boolean"
              },
              "sunday": {
                "type": "boolean"
              },
              "start_time": {
                "type": "string"
              },
              "end_time": {
                "type": "string"
              },
              "timezone": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "updated_at": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute emailbison_create_campaign_schedule --payload '{
  "campaign_id": "integer",
  "monday": false,
  "tuesday": false,
  "wednesday": false,
  "thursday": false,
  "friday": false,
  "saturday": false,
  "sunday": false,
  "start_time": "string",
  "end_time": "string",
  "timezone": "string",
  "save_as_template": false
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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