Edit a shift

Needs: Roster, Read-write

Edits a shift. Send only what changes. A recurring shift needs scope, and recurrence changes apply to this and following. Adding a second client converts the shift into a group shift. Completed and cancelled shifts cannot be edited.

Note: The response also has a message. It adds series_refs when you change a recurrence, converted_from when the shift becomes a group shift (or the reverse), replaces when the ref changes, and scope for recurring shifts.

curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/shifts/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "staff": [
    {
      "staff_id": 32
    }
  ],
  "publish": true
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/shifts/example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "staff": [
    {
      "staff_id": 32
    }
  ],
  "publish": true
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/shifts/example_string", {
  method: "PATCH",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "staff": [
    {
      "staff_id": 32
    }
  ],
  "publish": true
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "staff": [
    {
      "staff_id": 32
    }
  ],
  "publish": true
}`)

    req, err := http.NewRequest("PATCH", "https://app.imploy.com.au/api/integrations/v1/shifts/example_string", 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/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "staff": [
    {
      "staff_id": 32
    }
  ],
  "publish": true
}'

response = http.request(request)
puts response.body

{
  "updated": "a:123"
}

PATCH

/shifts/{ref}

PATCH

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.

path

refstring

Required

The shift ref, such as a:123.

Content-Typestring

Required

The media type of the request body

Options: application/json

scopestring

Recurring shifts need this or this_and_following.

shift_poolboolean

Unassign staff and offer the shift in the shift pool.

confirm_warningsboolean

Save despite staff warnings. Only use after confirming.

clientsarray

Client ids, 1 to 20. One client is a normal shift, two or more is a group shift.

startstring

Start, YYYY-MM-DD HH:MM in the organisation's time.

endstring

End, YYYY-MM-DD HH:MM. Must be after the start, and no more than 24 hours later.

staffarray

Array of staff_id (required) with an optional service for that person. Empty means a shift pool shift (single client only). Several means a multi-staff shift. Up to 10.

servicestring

A service name from the services endpoint. NDIS clients use NDIS services.

titlestring

Up to 255 characters.

addressstring

Up to 500 characters. Defaults to the client's address (or the site's).

commentsstring

Up to 5000 characters.

publishboolean

Publish to staff now. A new shift is a draft unless this is true; on edit it is unchanged.

site_idinteger

Makes it a site shift at this site. The clients must be site participants, and services are NDIS services.

recurrenceobject

Makes the shift repeat. frequency (Day, Week or Month) is required, with ends_on (YYYY-MM-DD, within two years) or occurrences (1 to 366). Also every (1 to 52), days (Mon to Sun, weekly), month_day (1 to 31) or month_week (First to Fourth, or Last) with month_weekday.

segmentsarray

Splits the shift into service blocks per staff member. Each needs staff_id, start, end and service. Up to 20.

funding_sourcestring

One of hcp, hcp_unspent, sah, temporary, tsah, thcp, ghcp or private. Defaults to the scheduler default.

temporary_funding_idstring

Required when funding_source is temporary.

charge_splitarray

Group shifts. Percent of the charge per client, each with client_id and percent (0 to 100), and optionally funding_source and temporary_funding_id. Defaults to an even split.

full_charge_per_clientboolean

Group shifts. Charge every client 100% instead of splitting.

apply_travel_claimboolean

Staff can claim travel for this shift.

travelobject

Travel details, which turn on apply_travel_claim. planned_kms (0 to 2000), charge_client (NDIS clients only), service (an NDIS travel service, required when charge_client is true) and charge_split for group shifts. On edit only the keys you send change, and null removes the travel details.

group_priceobject

Group or site shifts only. Bills the whole shift at one service, with mode of hourly (default) or fixed. null removes it.

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

scopestring

Recurring shifts need this or this_and_following.

shift_poolboolean

Unassign staff and offer the shift in the shift pool.

confirm_warningsboolean

Save despite staff warnings. Only use after confirming.

clientsarray

Client ids, 1 to 20. One client is a normal shift, two or more is a group shift.

startstring

Start, YYYY-MM-DD HH:MM in the organisation's time.

endstring

End, YYYY-MM-DD HH:MM. Must be after the start, and no more than 24 hours later.

staffarray

Array of staff_id (required) with an optional service for that person. Empty means a shift pool shift (single client only). Several means a multi-staff shift. Up to 10.

servicestring

A service name from the services endpoint. NDIS clients use NDIS services.

titlestring

Up to 255 characters.

addressstring

Up to 500 characters. Defaults to the client's address (or the site's).

commentsstring

Up to 5000 characters.

publishboolean

Publish to staff now. A new shift is a draft unless this is true; on edit it is unchanged.

site_idinteger

Makes it a site shift at this site. The clients must be site participants, and services are NDIS services.

recurrenceobject

segmentsarray

Splits the shift into service blocks per staff member. Each needs staff_id, start, end and service. Up to 20.

funding_sourcestring

One of hcp, hcp_unspent, sah, temporary, tsah, thcp, ghcp or private. Defaults to the scheduler default.

temporary_funding_idstring

Required when funding_source is temporary.

charge_splitarray

Group shifts. Percent of the charge per client, each with client_id and percent (0 to 100), and optionally funding_source and temporary_funding_id. Defaults to an even split.

full_charge_per_clientboolean

Group shifts. Charge every client 100% instead of splitting.

apply_travel_claimboolean

Staff can claim travel for this shift.

travelobject

group_priceobject

Group or site shifts only. Bills the whole shift at one service, with mode of hourly (default) or fixed. null removes it.

Responses

Was this page helpful?