Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Schedules

Create a schedule

<small>Requires the sequences:write scope (or a broader one that includes it).</small>

Creates a new schedule with timing configuration.

post/v3/schedules

Request body

namestring required

Name of the schedule

timezoneIdstring required

IANA timezone identifier (e.g., "America/New_York")

excludeHolidaysboolean

Whether to skip sending on holidays from linked calendars

useProspectTimezoneboolean

Whether to use the prospect's timezone instead of the schedule timezone

useFollowUpScheduleboolean

Whether a separate follow-up schedule is enabled

Example request

{
  "name": "Evening outreach",
  "timezoneId": "Europe/London",
  "excludeHolidays": false,
  "useProspectTimezone": true,
  "useFollowUpSchedule": false,
  "mainTimings": [
    {
      "weekDay": "Monday",
      "isActive": true,
      "timeRanges": [
        {
          "fromTime": {
            "hour": 18,
            "minute": 0
          },
          "toTime": {
            "hour": 21,
            "minute": 0
          }
        }
      ]
    }
  ],
  "followUpTimings": []
}

Response

Schedule created successfully

idinteger

Unique identifier for the schedule

namestring

Name of the schedule

timezoneIdstring

IANA timezone identifier (e.g., "America/New_York")

excludeHolidaysboolean

Whether to skip sending on holidays from linked calendars

useProspectTimezoneboolean

Whether to use the prospect's timezone instead of the schedule timezone

useFollowUpScheduleboolean

Whether a separate follow-up schedule is enabled

isDefaultboolean

Whether this is the default schedule

statusstring

Current status of the schedule

Example response

{
  "id": 1,
  "name": "Business hours",
  "timezoneId": "America/New_York",
  "excludeHolidays": true,
  "useProspectTimezone": false,
  "useFollowUpSchedule": false,
  "mainTimings": [
    {
      "weekDay": "Monday",
      "isActive": true,
      "timeRanges": [
        {
          "fromTime": {
            "hour": 9,
            "minute": 0
          },
          "toTime": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    }
  ],
  "followUpTimings": [],
  "isDefault": true,
  "status": "active"
}