schedules

Create a schedule

Create a sending schedule that can be assigned to one or more sequences.

<strong>Required fields</strong>: <code>name</code>, <code>timezone</code> (IANA Time Zone Database identifier, e.g. <code>Asia/Kolkata</code>), and <code>timeSlots</code> (per-day sending windows).

Set <code>isDefault: true</code> to make this the caller's default schedule — it will be assigned automatically to new sequences that do not specify one.

post/v1/schedules

Request body

namestring required

Human-readable label for the schedule.

timezonestring required

IANA timezone identifier (e.g. <code>America/New_York</code>, <code>Asia/Kolkata</code>). Must be a valid entry from the IANA Time Zone Database.

isDefaultboolean

If true, mark this schedule as the account default. New sequences without an explicit scheduleId will use this schedule.

Example request

{
  "name": "Weekdays 9-5",
  "timezone": "America/New_York",
  "timeSlots": [
    {
      "day": 0,
      "slots": []
    },
    {
      "day": 1,
      "slots": [
        {
          "start": {
            "hour": 9,
            "minute": 0
          },
          "end": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    },
    {
      "day": 2,
      "slots": [
        {
          "start": {
            "hour": 9,
            "minute": 0
          },
          "end": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    },
    {
      "day": 3,
      "slots": [
        {
          "start": {
            "hour": 9,
            "minute": 0
          },
          "end": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    },
    {
      "day": 4,
      "slots": [
        {
          "start": {
            "hour": 9,
            "minute": 0
          },
          "end": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    },
    {
      "day": 5,
      "slots": [
        {
          "start": {
            "hour": 9,
            "minute": 0
          },
          "end": {
            "hour": 17,
            "minute": 0
          }
        }
      ]
    },
    {
      "day": 6,
      "slots": []
    }
  ]
}

Response

Schedule created successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.