Update Schedule

Updates an existing schedule’s parameters.

PATCH /schedules/{scheduleId}

Update Schedule

cURL

curl --request PATCH \
  --url https://api.lemlist.com/api/schedules/{scheduleId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Schedule new name"
}
'

import requests

url = "https://api.lemlist.com/api/schedules/{scheduleId}"

payload = { "name": "Schedule new name" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Schedule new name'})
};

fetch('https://api.lemlist.com/api/schedules/{scheduleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/schedules/{scheduleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Schedule new name\"\n}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/schedules/{scheduleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Schedule new name'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "_id": "skd_iQiNG7VinWIUkgLy1",
  "name": "Renamed Schedule",
  "secondsToWait": 1000,
  "timezone": "Europe/Berlin",
  "start": "08:00",
  "end": "18:00",
  "weekdays": [
    1,
    2,
    3,
    2,
    5
  ],
  "public": true,
  "teamId": "tea_8QvkOiBfPdb2ZRhHi",
  "createdBy": "usr_ahfFktBBHUIxbVG5P",
  "createdAt": "2025-10-27T09:41:11.187Z"
}

{
  "error": "BadRequest",
  "message": "Bad team or invalid schedule update"
}

{
  "error": "The authentication you supplied is incorrect"
}

{
  "error": "Schedule not found"
}

This endpoint uses the Schedule object.

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

scheduleId · string · required

The unique identifier of the schedule

Body

application/json

name · string

The name of the schedule

secondsToWait · integer

Delay in seconds between operations

timezone · string

Timezone for the schedule (e.g., 'Europe/Paris')

start · string

Start time in HH:mm format

Pattern: ^([01]\d|2[0-3]):[0-5]\d$

end · string

End time in HH:mm format

Pattern: ^([01]\d|2[0-3]):[0-5]\d$

weekdays · integer[]

Days of the week the schedule is active (1=Monday, 7=Sunday)

Required range: 1 <= x <= 7

public · boolean

Set to true to make the schedule visible to use as a template

Response

200

application/json

Schedule successfully updated

Sending time windows defining when campaigns can send messages (days and hours).

_id · string

Unique schedule identifier

name · string

Schedule name

secondsToWait · integer

Seconds between sends

timezone · string

Schedule timezone (e.g., 'Europe/Paris')

start · string

Daily start time (HH:mm)

Pattern: ^([01]\d|2[0-3]):[0-5]\d$

end · string

Daily end time (HH:mm)

Pattern: ^([01]\d|2[0-3]):[0-5]\d$

weekdays · integer[]

Active weekdays (1=Monday, 7=Sunday)

Required range: 1 <= x <= 7

public · boolean

Whether the schedule is available as a template for other users

teamId · string

Unique identifier of the team that owns this schedule

createdBy · string

Unique identifier of the user who created this schedule

createdAt · string<date-time>

Timestamp when the schedule was created

deletedAt · string<date-time>

Timestamp when the schedule was deleted (only present if deleted)

deletedBy · string

Unique identifier of the user who deleted this schedule (only present if deleted)