Bulk create

Needs: Clients, Read-write

Creates up to 50 clients like the Add client form, with the same checks, locations and custom attributes. Every row is checked first. A possible duplicate (same name, and date of birth when given) is refused unless you send allow_duplicates. Duplicates inside the same request are always refused.

Note: business_id can be left out when the organisation has one location. status for a new client can be Active, Inactive or Hospital leave. A contacts entry takes name, phone, relationship and type (Primary Contact or Secondary Contact), with optional email and address. A health_professionals entry takes name and phone, with optional type, department, specialty, email and address.

Tip: Run with dry_run first. Rows that fail come back with ok: false and an error, while the rest are still reported.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/clients/bulk" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "dry_run": true,
  "clients": [
    {
      "first_name": "Example",
      "last_name": "Client",
      "client_type": "NDIS",
      "business_id": 1,
      "date_of_birth": "1980-05-20",
      "gender": "Female",
      "address": "1 Example St, Perth WA 6000",
      "contacts": [
        {
          "name": "Example Contact",
          "phone": "0400 000 000",
          "relationship": "Daughter",
          "type": "Primary Contact"
        }
      ]
    }
  ]
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/clients/bulk"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "dry_run": true,
  "clients": [
    {
      "first_name": "Example",
      "last_name": "Client",
      "client_type": "NDIS",
      "business_id": 1,
      "date_of_birth": "1980-05-20",
      "gender": "Female",
      "address": "1 Example St, Perth WA 6000",
      "contacts": [
        {
          "name": "Example Contact",
          "phone": "0400 000 000",
          "relationship": "Daughter",
          "type": "Primary Contact"
        }
      ]
    }
  ]
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/clients/bulk", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "dry_run": true,
  "clients": [
    {
      "first_name": "Example",
      "last_name": "Client",
      "client_type": "NDIS",
      "business_id": 1,
      "date_of_birth": "1980-05-20",
      "gender": "Female",
      "address": "1 Example St, Perth WA 6000",
      "contacts": [
        {
          "name": "Example Contact",
          "phone": "0400 000 000",
          "relationship": "Daughter",
          "type": "Primary Contact"
        }
      ]
    }
  ]
})
});

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

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "dry_run": true,
  "clients": [
    {
      "first_name": "Example",
      "last_name": "Client",
      "client_type": "NDIS",
      "business_id": 1,
      "date_of_birth": "1980-05-20",
      "gender": "Female",
      "address": "1 Example St, Perth WA 6000",
      "contacts": [
        {
          "name": "Example Contact",
          "phone": "0400 000 000",
          "relationship": "Daughter",
          "type": "Primary Contact"
        }
      ]
    }
  ]
}`)

    req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/clients/bulk", 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/bulk')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "dry_run": true,
  "clients": [
    {
      "first_name": "Example",
      "last_name": "Client",
      "client_type": "NDIS",
      "business_id": 1,
      "date_of_birth": "1980-05-20",
      "gender": "Female",
      "address": "1 Example St, Perth WA 6000",
      "contacts": [
        {
          "name": "Example Contact",
          "phone": "0400 000 000",
          "relationship": "Daughter",
          "type": "Primary Contact"
        }
      ]
    }
  ]
}'

response = http.request(request)
puts response.body

{
  "dry_run": true,
  "ready": 1,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "name": "Example Client",
      "status": "would_create"
    }
  ]
}

POST

/clients/bulk

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.

Content-Typestring

Required

The media type of the request body

Options: application/json

clientsarray

Required

1 to 50 client objects. Each takes first_name, last_name and client_type, plus optional business_id, date_of_birth, gender, address, status, contacts, health_professionals and custom_attributes.