Delete shifts
Needs: Roster, Read-write
Deletes up to 50 shifts, with the refs in the body. A started or cancelled shift is soft-deleted and its billing voided, and any other shift is removed. Confirm before calling this.
curl -X DELETE "https://app.imploy.com.au/api/integrations/v1/shifts" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"refs": [
"a:123",
"a:124"
],
"scope": "this"
}'
import requests
import json
url = "https://app.imploy.com.au/api/integrations/v1/shifts"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"refs": [
"a:123",
"a:124"
],
"scope": "this"
}
response = requests.delete(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app.imploy.com.au/api/integrations/v1/shifts", {
method: "DELETE",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"refs": [
"a:123",
"a:124"
],
"scope": "this"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"refs": [
"a:123",
"a:124"
],
"scope": "this"
}`)
req, err := http.NewRequest("DELETE", "https://app.imploy.com.au/api/integrations/v1/shifts", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app.imploy.com.au/api/integrations/v1/shifts')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"refs": [
"a:123",
"a:124"
],
"scope": "this"
}'
response = http.request(request)
puts response.body
{
"succeeded": 1,
"failed": 1,
"results": [
{
"ref": "a:123",
"ok": true,
"message": "..."
},
{
"ref": "a:124",
"ok": false,
"error": "Shift not found or already deleted."
}
]
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Too many requests."
}
/shifts
Target server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.The media type of the request body
1 to 50 shift refs.
For recurring shifts, this_and_following also deletes the following shifts in the series.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Body
1 to 50 shift refs.
For recurring shifts, this_and_following also deletes the following shifts in the series.
Responses
OK