POST [ staff/{people_custom1}
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}
Overview
This endpoint is used to update a staff user’s data for example first_name, last_name, mobile, and many more in the ComplyFlow system.
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user should poss both below permissions:
API User
User is Staff
Users have View and Edit Staff Permission
The user has the same Organisation as the selected Staff
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
|
| Custom ID used to get staff detail data |
| YES |
|
|
Body properties/Payload
FIELD | TYPE | DESCRIPTION | REQUIRED |
|
| Set staff’s first name | No |
|
| Set staff’s last name | No |
|
| Custom ID used to get staff detail data | No |
|
| Staff’s mobile phone number without country code (+XX) (E.g. 123123123) | No |
|
| Staff’s address zip code | No |
|
| Staff’s address | No |
|
| Staff’s date of birth with YYYY-MM-DD Format (E.g. 2000-01-01) | No |
|
| Staff’s job title | No |
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/staff1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]' \
--form 'first_name="staff"' \
--form 'last_name="test"' \
--form 'people_custom1="staffsatu"' \
--form 'mobile="43214321"' \
--form 'postcode="14450"' \
--form 'address="Sana Sini St"' \
--form 'dob="2000-01-01"' \
--form 'job_title="The One"'
Response Example
The API Request returns the status of this API action.
{
"token": "",
"data": {
"success": true
}
}
Response Information
Status | Response |
|
|
|
|