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
422naming 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"
}'
import requests
import json
url = "https://app.imploy.com.au/api/integrations/v1/clients/123"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"primary_contact_number": "0400 111 222",
"address": "2 Example St, Perth WA 6000"
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app.imploy.com.au/api/integrations/v1/clients/123", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"primary_contact_number": "0400 111 222",
"address": "2 Example St, Perth WA 6000"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"primary_contact_number": "0400 111 222",
"address": "2 Example St, Perth WA 6000"
}`)
req, err := http.NewRequest("PATCH", "https://app.imploy.com.au/api/integrations/v1/clients/123", 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/clients/123')
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 = '{
"primary_contact_number": "0400 111 222",
"address": "2 Example St, Perth WA 6000"
}'
response = http.request(request)
puts response.body
{
"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"
}
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Record not found."
}
{
"message": "Too many requests."
}
/clients/{id}Target server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.The client id.
The media type of the request body
Up to 100 characters. Required on create.
Up to 100 characters. Required on create.
One of HCP, SaH, THCP, GHCP, NDIS or Private. Required on create.
The id of a business location. Required on create. Use the create options endpoint to see the locations you can use.
Up to 100 characters. Defaults to English on create.
Up to 500 characters, or null. Defaults to null on create.
A valid email, up to 255 characters, or null.
Up to 40 characters, or null.
Active or Archived. Defaults to Active on create.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Path Parameters
The client id.
Body
Up to 100 characters. Required on create.
Up to 100 characters. Required on create.
One of HCP, SaH, THCP, GHCP, NDIS or Private. Required on create.
The id of a business location. Required on create. Use the create options endpoint to see the locations you can use.
Up to 100 characters. Defaults to English on create.
Up to 500 characters, or null. Defaults to null on create.
A valid email, up to 255 characters, or null.
Up to 40 characters, or null.
Active or Archived. Defaults to Active on create.
Responses
OK