ClientsUpdate a client

Update a client

Needs: Clients, Read-write

Changes only the fields you send. The response is the updated client.

Note: A field outside the list above returns a 422 naming the unsupported fields.

curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/clients/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "primary_contact_number": "0400 111 222",
  "address": "2 Example St, Perth WA 6000"
}'
{
  "data": {
    "id": 12,
    "first_name": "Example",
    "last_name": "Client",
    "primary_contact_email": "example.client@example.com",
    "primary_contact_number": "0400 000 000",
    "address": "1 Example St, Perth WA 6000",
    "client_type": "NDIS",
    "business_id": 1,
    "status": "Active",
    "created_at": "2026-01-12T03:20:41.000000Z",
    "updated_at": "2026-02-03T08:05:10.000000Z"
  }
}
PATCH
/clients/{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.
path
idinteger
Required

The client id.

Content-Typestring
Required

The media type of the request body

Options: application/json
first_namestring

Up to 100 characters. Required on create.

last_namestring

Up to 100 characters. Required on create.

client_typestring

One of HCP, SaH, THCP, GHCP, NDIS or Private. Required on create.

business_idinteger

The id of a business location. Required on create. Use the create options endpoint to see the locations you can use.

languagestring

Up to 100 characters. Defaults to English on create.

addressstring

Up to 500 characters, or null. Defaults to null on create.

primary_contact_emailstring

A valid email, up to 255 characters, or null.

primary_contact_numberstring

Up to 40 characters, or null.

statusstring

Active or Archived. Defaults to Active on create.

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 client id.

Body

application/json
first_namestring

Up to 100 characters. Required on create.

last_namestring

Up to 100 characters. Required on create.

client_typestring

One of HCP, SaH, THCP, GHCP, NDIS or Private. Required on create.

business_idinteger

The id of a business location. Required on create. Use the create options endpoint to see the locations you can use.

languagestring

Up to 100 characters. Defaults to English on create.

addressstring

Up to 500 characters, or null. Defaults to null on create.

primary_contact_emailstring

A valid email, up to 255 characters, or null.

primary_contact_numberstring

Up to 40 characters, or null.

statusstring

Active or Archived. Defaults to Active on create.

Responses

OK