SitesEdit a site

Edit a site

Needs: Roster, Read-write

Edits a site's details, status, capacity, description, manager and members. Send only what changes. Use participants, support_staff and admin_staff to replace a list, or the add_ and remove_ versions to change it.

curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/sites/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "status": "Maintenance",
  "add_participants": [
    15
  ],
  "remove_support_staff": [
    31
  ]
}'
{
  "updated": 4,
  "site": {
    "id": 4,
    "name": "Example House",
    "type": "Supported Independent Living",
    "status": "Active",
    "address": "10 Example Rd, Perth WA 6000",
    "client_capacity": 4,
    "manager": "Example Manager",
    "participants": [
      {
        "id": 12,
        "name": "Example Client"
      }
    ],
    "support_staff": [
      {
        "id": 31,
        "name": "Example Worker"
      }
    ],
    "admin_staff": [
      {
        "id": 40,
        "name": "Example Admin"
      }
    ]
  }
}
PATCH
/sites/{id}
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.

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
namestring

Up to 255 characters. Required on create.

addressstring

Up to 500 characters. Required on create.

statusstring

Active, Inactive or Maintenance. A new site is Active unless you say otherwise.

typestring

For example Supported Independent Living.

location_idinteger

The business location. Required when the organisation has more than one.

manager_idinteger

Staff id of the site manager, or null.

emailstring

A valid email, or null.

phonestring

Up to 50 characters, or null.

client_capacityinteger

0 to 1000, or null.

maximum_staffinteger

0 to 1000, or null.

descriptionstring

Up to 20000 characters.

tagsarray

Tag names, up to 50. Colours are not set unless you send {name, color}.

participantsarray

Client ids who live at or attend the site. Replaces the list on edit.

support_staffarray

Staff ids. Replaces the list on edit.

admin_staffarray

Staff ids. Replaces the list on edit.

add_participantsarray

Client ids to add.

remove_participantsarray

Client ids to remove.

add_support_staffarray

Staff ids to add.

remove_support_staffarray

Staff ids to remove.

add_admin_staffarray

Staff ids to add.

remove_admin_staffarray

Staff ids to remove.

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

idinteger
Required

The site id.

Body

application/json
namestring

Up to 255 characters. Required on create.

addressstring

Up to 500 characters. Required on create.

statusstring

Active, Inactive or Maintenance. A new site is Active unless you say otherwise.

typestring

For example Supported Independent Living.

location_idinteger

The business location. Required when the organisation has more than one.

manager_idinteger

Staff id of the site manager, or null.

emailstring

A valid email, or null.

phonestring

Up to 50 characters, or null.

client_capacityinteger

0 to 1000, or null.

maximum_staffinteger

0 to 1000, or null.

descriptionstring

Up to 20000 characters.

tagsarray

Tag names, up to 50. Colours are not set unless you send {name, color}.

participantsarray

Client ids who live at or attend the site. Replaces the list on edit.

support_staffarray

Staff ids. Replaces the list on edit.

admin_staffarray

Staff ids. Replaces the list on edit.

add_participantsarray

Client ids to add.

remove_participantsarray

Client ids to remove.

add_support_staffarray

Staff ids to add.

remove_support_staffarray

Staff ids to remove.

add_admin_staffarray

Staff ids to add.

remove_admin_staffarray

Staff ids to remove.

Responses

OK