Partially updates one or more employee records. Only fields that are present in the request body are written — omitting a field leaves the existing value unchanged. Requires an API key with KeyType=developer.
PATCH
/
api
/
external
/
staffs
Bulk update employees
curl --request PATCH \
--url https://gateway-api.guardhousehq.com/api/external/staffs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'external-gh-apim-sub-key: <api-key>' \
--data '
{
"employees": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"knownAsFirstName": "<string>",
"knownAsLastName": "<string>",
"gender": "<string>",
"employeeId": "<string>",
"employeeReferenceNumber": 123,
"startDate": "2023-11-07T05:31:56Z",
"dateOfBirth": "2023-11-07T05:31:56Z",
"emergencyContactName": "<string>",
"emergencyContactNumber": "<string>",
"address": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postCode": "<string>",
"countryCode": "<string>"
}
]
}
'import requests
url = "https://gateway-api.guardhousehq.com/api/external/staffs"
payload = { "employees": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"knownAsFirstName": "<string>",
"knownAsLastName": "<string>",
"gender": "<string>",
"employeeId": "<string>",
"employeeReferenceNumber": 123,
"startDate": "2023-11-07T05:31:56Z",
"dateOfBirth": "2023-11-07T05:31:56Z",
"emergencyContactName": "<string>",
"emergencyContactNumber": "<string>",
"address": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postCode": "<string>",
"countryCode": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"external-gh-apim-sub-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'external-gh-apim-sub-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
employees: [
{
id: 123,
firstName: '<string>',
lastName: '<string>',
middleName: '<string>',
email: 'jsmith@example.com',
mobile: '<string>',
knownAsFirstName: '<string>',
knownAsLastName: '<string>',
gender: '<string>',
employeeId: '<string>',
employeeReferenceNumber: 123,
startDate: '2023-11-07T05:31:56Z',
dateOfBirth: '2023-11-07T05:31:56Z',
emergencyContactName: '<string>',
emergencyContactNumber: '<string>',
address: '<string>',
city: '<string>',
stateCode: '<string>',
postCode: '<string>',
countryCode: '<string>'
}
]
})
};
fetch('https://gateway-api.guardhousehq.com/api/external/staffs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway-api.guardhousehq.com/api/external/staffs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'employees' => [
[
'id' => 123,
'firstName' => '<string>',
'lastName' => '<string>',
'middleName' => '<string>',
'email' => 'jsmith@example.com',
'mobile' => '<string>',
'knownAsFirstName' => '<string>',
'knownAsLastName' => '<string>',
'gender' => '<string>',
'employeeId' => '<string>',
'employeeReferenceNumber' => 123,
'startDate' => '2023-11-07T05:31:56Z',
'dateOfBirth' => '2023-11-07T05:31:56Z',
'emergencyContactName' => '<string>',
'emergencyContactNumber' => '<string>',
'address' => '<string>',
'city' => '<string>',
'stateCode' => '<string>',
'postCode' => '<string>',
'countryCode' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"external-gh-apim-sub-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway-api.guardhousehq.com/api/external/staffs"
payload := strings.NewReader("{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("external-gh-apim-sub-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://gateway-api.guardhousehq.com/api/external/staffs")
.header("Authorization", "Bearer <token>")
.header("external-gh-apim-sub-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway-api.guardhousehq.com/api/external/staffs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["external-gh-apim-sub-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}Authorizations
JWT issued by POST /api/external/token/request. Send as Authorization: Bearer <token>.
Guardhouse API Management subscription key. Required on every request. The same value is used by all API consumers within a region — contact Guardhouse Support for the subscription key.
Body
application/json
Show child attributes
Show child attributes
⌘I
Bulk update employees
curl --request PATCH \
--url https://gateway-api.guardhousehq.com/api/external/staffs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'external-gh-apim-sub-key: <api-key>' \
--data '
{
"employees": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"knownAsFirstName": "<string>",
"knownAsLastName": "<string>",
"gender": "<string>",
"employeeId": "<string>",
"employeeReferenceNumber": 123,
"startDate": "2023-11-07T05:31:56Z",
"dateOfBirth": "2023-11-07T05:31:56Z",
"emergencyContactName": "<string>",
"emergencyContactNumber": "<string>",
"address": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postCode": "<string>",
"countryCode": "<string>"
}
]
}
'import requests
url = "https://gateway-api.guardhousehq.com/api/external/staffs"
payload = { "employees": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"knownAsFirstName": "<string>",
"knownAsLastName": "<string>",
"gender": "<string>",
"employeeId": "<string>",
"employeeReferenceNumber": 123,
"startDate": "2023-11-07T05:31:56Z",
"dateOfBirth": "2023-11-07T05:31:56Z",
"emergencyContactName": "<string>",
"emergencyContactNumber": "<string>",
"address": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postCode": "<string>",
"countryCode": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"external-gh-apim-sub-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'external-gh-apim-sub-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
employees: [
{
id: 123,
firstName: '<string>',
lastName: '<string>',
middleName: '<string>',
email: 'jsmith@example.com',
mobile: '<string>',
knownAsFirstName: '<string>',
knownAsLastName: '<string>',
gender: '<string>',
employeeId: '<string>',
employeeReferenceNumber: 123,
startDate: '2023-11-07T05:31:56Z',
dateOfBirth: '2023-11-07T05:31:56Z',
emergencyContactName: '<string>',
emergencyContactNumber: '<string>',
address: '<string>',
city: '<string>',
stateCode: '<string>',
postCode: '<string>',
countryCode: '<string>'
}
]
})
};
fetch('https://gateway-api.guardhousehq.com/api/external/staffs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway-api.guardhousehq.com/api/external/staffs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'employees' => [
[
'id' => 123,
'firstName' => '<string>',
'lastName' => '<string>',
'middleName' => '<string>',
'email' => 'jsmith@example.com',
'mobile' => '<string>',
'knownAsFirstName' => '<string>',
'knownAsLastName' => '<string>',
'gender' => '<string>',
'employeeId' => '<string>',
'employeeReferenceNumber' => 123,
'startDate' => '2023-11-07T05:31:56Z',
'dateOfBirth' => '2023-11-07T05:31:56Z',
'emergencyContactName' => '<string>',
'emergencyContactNumber' => '<string>',
'address' => '<string>',
'city' => '<string>',
'stateCode' => '<string>',
'postCode' => '<string>',
'countryCode' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"external-gh-apim-sub-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway-api.guardhousehq.com/api/external/staffs"
payload := strings.NewReader("{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("external-gh-apim-sub-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://gateway-api.guardhousehq.com/api/external/staffs")
.header("Authorization", "Bearer <token>")
.header("external-gh-apim-sub-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway-api.guardhousehq.com/api/external/staffs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["external-gh-apim-sub-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employees\": [\n {\n \"id\": 123,\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"knownAsFirstName\": \"<string>\",\n \"knownAsLastName\": \"<string>\",\n \"gender\": \"<string>\",\n \"employeeId\": \"<string>\",\n \"employeeReferenceNumber\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"emergencyContactName\": \"<string>\",\n \"emergencyContactNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"postCode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}{
"status": {
"code": 123,
"errorMessage": "<string>"
},
"data": "<unknown>",
"count": 123,
"message": "<string>",
"errors": [
{
"code": 100,
"message": "<string>"
}
]
}