RosterCancel a shift

Cancel a shift

Needs: Roster, Read-write

Cancels a shift. It stays on the roster as cancelled. Confirm charge_client and pay_staff before calling this.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/shifts/example_string/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "reason": "Client in hospital",
  "charge_client": false,
  "pay_staff": true
}'
{
  "cancelled": "a:123",
  "message": "..."
}
POST
/shifts/{ref}/cancel
POST
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.
path
refstring
Required

The shift ref, such as a:123.

Content-Typestring
Required

The media type of the request body

Options: application/json
reasonstring
Required

Up to 1000 characters.

charge_clientboolean
Required

Charge the client a cancellation fee.

pay_staffboolean
Required

Still pay the staff member.

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.

Path Parameters

refstring
Required

The shift ref, such as a:123.

Body

application/json
reasonstring
Required

Up to 1000 characters.

charge_clientboolean
Required

Charge the client a cancellation fee.

pay_staffboolean
Required

Still pay the staff member.

Responses

OK