POST [ staff/{people_custom1}/activate]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/activate
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/activate
Overview
This endpoint is used to activate a staff from the ComplyFlow system.
{people_custom1} can be renamed to any parameter for the account that makes sense, e.g. Internal Staff ID
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user should possess both below permissions:
API User
User is Staff
User 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 |
|
|
The Custom ID needs to be configured on each Staff User’s profile - the ID needs to be unique
Request Example
curl --location --request POST 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/staff1/activate' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns the status of this API action.
{
"token": "",
"data": {
"success": true
}
}
Response Information
Status | Response |
|
|
|
|