Delete
curl --request POST \
--url https://api.example.com/api/schedule/schedules.delete \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"872815618512410358"
],
"options": {
"group_action": "single",
"allow_partial": true
}
}
'import requests
url = "https://api.example.com/api/schedule/schedules.delete"
payload = {
"ids": ["872815618512410358"],
"options": {
"group_action": "single",
"allow_partial": True
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['872815618512410358'],
options: {group_action: 'single', allow_partial: true}
})
};
fetch('https://api.example.com/api/schedule/schedules.delete', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/schedule/schedules.delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'872815618512410358'
],
'options' => [
'group_action' => 'single',
'allow_partial' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/schedule/schedules.delete"
payload := strings.NewReader("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/schedule/schedules.delete")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"deleted_count": 123,
"deleted": {},
"failed_count": 123,
"failed": {}
}{
"warning_type": "locked_schedules",
"description": "<string>",
"details": {
"schedules_to_delete_count": 123,
"locked_schedules_count": 123,
"locked_schedules_date_range": "2019-11-11/2019-12-12",
"locked_teams": [
{
"team_id": 123,
"locked_date": "2019-11-11"
}
]
},
"required_action": "<string>"
}Schedules
Delete
Deletes one or several schedules. If you provide ‘all’ or ‘future’ as group action and if you allow it through ‘allow_partial=true’, only the schedules that come after team’s lock date (if it exists) will be deleted.
POST
/
api
/
schedule
/
schedules.delete
Delete
curl --request POST \
--url https://api.example.com/api/schedule/schedules.delete \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"872815618512410358"
],
"options": {
"group_action": "single",
"allow_partial": true
}
}
'import requests
url = "https://api.example.com/api/schedule/schedules.delete"
payload = {
"ids": ["872815618512410358"],
"options": {
"group_action": "single",
"allow_partial": True
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['872815618512410358'],
options: {group_action: 'single', allow_partial: true}
})
};
fetch('https://api.example.com/api/schedule/schedules.delete', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/schedule/schedules.delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'872815618512410358'
],
'options' => [
'group_action' => 'single',
'allow_partial' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/schedule/schedules.delete"
payload := strings.NewReader("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/schedule/schedules.delete")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"options\": {\n \"group_action\": \"single\",\n \"allow_partial\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"deleted_count": 123,
"deleted": {},
"failed_count": 123,
"failed": {}
}{
"warning_type": "locked_schedules",
"description": "<string>",
"details": {
"schedules_to_delete_count": 123,
"locked_schedules_count": 123,
"locked_schedules_date_range": "2019-11-11/2019-12-12",
"locked_teams": [
{
"team_id": 123,
"locked_date": "2019-11-11"
}
]
},
"required_action": "<string>"
}Response
Schedule(s) deleted. When options.allow_partial is true, some schedules might not be deleted due to lock dates or permissions.
⌘I