POST [ staff/{people_custom1}/deactivate ]
Production Endpoint:
https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/deactivate
Test Endpoint:
https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/deactivate
Overview
This endpoint is used to deactivate a staff from 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 |
|
|
Request Example
curl --location --request POST 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/staff1/deactivate' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns a list of staff from the current organisation:
{
"token": "",
"data": {
"success": true
}
}
Response Information
Status | Response |
|
|
|
|