Update a shift template
curl --request PATCH \
--url https://api.1club.ai/v1/platform/shift-templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"clubId": 123,
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": true,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
]
}
'import requests
url = "https://api.1club.ai/v1/platform/shift-templates/{id}"
payload = {
"name": "<string>",
"clubId": 123,
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": True,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
clubId: 123,
startTime: '06:00',
endTime: '14:00',
color: '<string>',
displayOrder: 123,
isActive: true,
breaks: [{name: 'Lunch', startTime: '12:00', endTime: '12:30'}]
})
};
fetch('https://api.1club.ai/v1/platform/shift-templates/{id}', 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.1club.ai/v1/platform/shift-templates/{id}",
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' => '<string>',
'clubId' => 123,
'startTime' => '06:00',
'endTime' => '14:00',
'color' => '<string>',
'displayOrder' => 123,
'isActive' => true,
'breaks' => [
[
'name' => 'Lunch',
'startTime' => '12:00',
'endTime' => '12:30'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.1club.ai/v1/platform/shift-templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.1club.ai/v1/platform/shift-templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/shift-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"clubId": 123,
"name": "<string>",
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": true,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Staff Roster
Update a shift template
Send only what changes; breaks, when sent, replaces the whole set. Shifts already on the staff roster keep the times they were generated with until their rotation is next regenerated.
PATCH
/
v1
/
platform
/
shift-templates
/
{id}
Update a shift template
curl --request PATCH \
--url https://api.1club.ai/v1/platform/shift-templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"clubId": 123,
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": true,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
]
}
'import requests
url = "https://api.1club.ai/v1/platform/shift-templates/{id}"
payload = {
"name": "<string>",
"clubId": 123,
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": True,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
clubId: 123,
startTime: '06:00',
endTime: '14:00',
color: '<string>',
displayOrder: 123,
isActive: true,
breaks: [{name: 'Lunch', startTime: '12:00', endTime: '12:30'}]
})
};
fetch('https://api.1club.ai/v1/platform/shift-templates/{id}', 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.1club.ai/v1/platform/shift-templates/{id}",
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' => '<string>',
'clubId' => 123,
'startTime' => '06:00',
'endTime' => '14:00',
'color' => '<string>',
'displayOrder' => 123,
'isActive' => true,
'breaks' => [
[
'name' => 'Lunch',
'startTime' => '12:00',
'endTime' => '12:30'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.1club.ai/v1/platform/shift-templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.1club.ai/v1/platform/shift-templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/shift-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"clubId\": 123,\n \"startTime\": \"06:00\",\n \"endTime\": \"14:00\",\n \"color\": \"<string>\",\n \"displayOrder\": 123,\n \"isActive\": true,\n \"breaks\": [\n {\n \"name\": \"Lunch\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:30\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"clubId": 123,
"name": "<string>",
"startTime": "06:00",
"endTime": "14:00",
"color": "<string>",
"displayOrder": 123,
"isActive": true,
"breaks": [
{
"name": "Lunch",
"startTime": "12:00",
"endTime": "12:30"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Path Parameters
Body
application/json
A shift template. On create name, startTime and endTime are required; on update send only what changes, and breaks, when sent, replaces the whole set.
Response
The updated template
A named shift a roster is built from, on the wall clock of the club it is worked at.
Was this page helpful?