RosterDelete shifts

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"
}'
{
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "ref": "a:123",
      "ok": true,
      "message": "..."
    },
    {
      "ref": "a:124",
      "ok": false,
      "error": "Shift not found or already deleted."
    }
  ]
}
DELETE
/shifts
DELETE
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Content-Typestring
Required

The media type of the request body

Options: application/json
refsarray
Required

1 to 50 shift refs.

scopestring

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

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Body

application/json
refsarray
Required

1 to 50 shift refs.

scopestring

For recurring shifts, this_and_following also deletes the following shifts in the series.

Responses

OK