RosterCreate an appointment

Create an appointment

Needs: Roster, Read-write

Creates an appointment. The end must be after the start. Any field outside the list returns a 422 naming the unsupported fields.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/appointments" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "appointment_title": "Morning support",
  "client_id": 12,
  "employee_id": 31,
  "start": "2026-03-02 09:00",
  "end": "2026-03-02 13:00",
  "appointment_address": "1 Example St, Perth WA 6000",
  "appointment_type": "Assistance With Self-Care Activities - Standard - Weekday Daytime"
}'
{
  "data": [
    {
      "id": 55,
      "appointment_title": "Morning support",
      "client_id": 12,
      "employee_id": 31,
      "start": "2026-03-02 09:00:00",
      "end": "2026-03-02 13:00:00",
      "appointment_address": "1 Example St, Perth WA 6000",
      "is_draft": 1,
      "appointment_cancelled": 0,
      "is_deleted": 0,
      "created_at": "2026-02-20T01:00:00.000000Z",
      "updated_at": "2026-02-20T01:00:00.000000Z"
    }
  ]
}
POST
/appointments
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.
Content-Typestring
Required

The media type of the request body

Options: application/json
appointment_titlestring
Required

Up to 200 characters. Required on create.

client_idinteger
Required

An existing client id. Required on create.

employee_idinteger

An existing staff id, or null. Suppliers and archived staff are refused.

startstring
Required

A date and time. Required on create.

endstring
Required

A date and time after the start. Required on create.

appointment_addressstring
Required

Up to 500 characters. Required on create.

appointment_typestring
Required

A configured service name (price book or NDIS price type). Required on create.

to_be_publishedboolean

Publish to staff.

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
appointment_titlestring
Required

Up to 200 characters. Required on create.

client_idinteger
Required

An existing client id. Required on create.

employee_idinteger

An existing staff id, or null. Suppliers and archived staff are refused.

startstring
Required

A date and time. Required on create.

endstring
Required

A date and time after the start. Required on create.

appointment_addressstring
Required

Up to 500 characters. Required on create.

appointment_typestring
Required

A configured service name (price book or NDIS price type). Required on create.

to_be_publishedboolean

Publish to staff.

Responses