Archive a client

Needs: Clients, Read-write

Archives the client by setting its status to Archived. The record is not removed, and the response is the archived client. To bring a client back, send PATCH with status set to Active.

curl -X DELETE "https://app.imploy.com.au/api/integrations/v1/clients/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

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"
}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/clients/123", {
  method: "DELETE",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

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

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("DELETE", "https://app.imploy.com.au/api/integrations/v1/clients/123", nil)
    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::Delete.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

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": "Archived",
    "created_at": "2026-01-12T03:20:41.000000Z",
    "updated_at": "2026-02-03T08:05:10.000000Z"
  }
}