Bulk create

Needs: Staff, Read-write

Creates up to 50 people like the Add staff form. Each starts as Pending and gets a set-password email. Email conflicts are checked first: someone already on staff here is refused, the owner login of another business is refused, and an email that already has an Imploy login elsewhere needs link_existing_accounts. Demo email addresses are refused.

Note: dob and onboarding_date are YYYY-MM-DD, and dob must be before today. If the person is created but extra fields or custom attributes fail to save, the row is still ok and carries a warning.

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

curl -X POST "https://app.imploy.com.au/api/integrations/v1/staff/bulk" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "dry_run": true,
  "staff": [
    {
      "email": "example.worker@example.com",
      "first_name": "Example",
      "last_name": "Worker",
      "role": "Support Worker",
      "address": "1 Example St, Perth WA 6000",
      "locations": [
        1
      ],
      "phone": "0400 000 000",
      "dob": "1990-04-12"
    }
  ]
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/staff/bulk"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "dry_run": true,
  "staff": [
    {
      "email": "example.worker@example.com",
      "first_name": "Example",
      "last_name": "Worker",
      "role": "Support Worker",
      "address": "1 Example St, Perth WA 6000",
      "locations": [
        1
      ],
      "phone": "0400 000 000",
      "dob": "1990-04-12"
    }
  ]
}

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

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/staff/bulk", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "dry_run": true,
  "staff": [
    {
      "email": "example.worker@example.com",
      "first_name": "Example",
      "last_name": "Worker",
      "role": "Support Worker",
      "address": "1 Example St, Perth WA 6000",
      "locations": [
        1
      ],
      "phone": "0400 000 000",
      "dob": "1990-04-12"
    }
  ]
})
});

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

package main

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

func main() {
    data := []byte(`{
  "dry_run": true,
  "staff": [
    {
      "email": "example.worker@example.com",
      "first_name": "Example",
      "last_name": "Worker",
      "role": "Support Worker",
      "address": "1 Example St, Perth WA 6000",
      "locations": [
        1
      ],
      "phone": "0400 000 000",
      "dob": "1990-04-12"
    }
  ]
}`)

    req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/staff/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/staff/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,
  "staff": [
    {
      "email": "example.worker@example.com",
      "first_name": "Example",
      "last_name": "Worker",
      "role": "Support Worker",
      "address": "1 Example St, Perth WA 6000",
      "locations": [
        1
      ],
      "phone": "0400 000 000",
      "dob": "1990-04-12"
    }
  ]
}'

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

{
  "dry_run": true,
  "ready": 1,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "email": "example.worker@example.com",
      "status": "would_create",
      "account": "new account (gets a set-password email)"
    }
  ]
}

{
  "created": 1,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "id": 32,
      "email": "example.worker@example.com",
      "status": "created",
      "account": "new_account"
    }
  ]
}

POST

/staff/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

staffarray

Required

1 to 50 people. Each needs email, first_name, last_name, role (a name or id) and address, plus locations (location ids, optional when the organisation has one). Optional: phone, dob, middle_name, preferred_name, nationality, onboarding_date, gender and custom_attributes.

dry_runboolean

Check every row, including email conflicts, without creating anyone or sending emails.

link_existing_accountsboolean

Allow emails that already have an Imploy login with another organisation. They get an invite instead of a set-password email. Only use after confirming.

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

staffarray

Required

dry_runboolean

Check every row, including email conflicts, without creating anyone or sending emails.

link_existing_accountsboolean

Allow emails that already have an Imploy login with another organisation. They get an invite instead of a set-password email. Only use after confirming.

Responses

Dry run

Was this page helpful?