API Docs
Voxbi Cockpit APIs
All endpoints

Change a scoped employee's current status as a validator (user)

Sets the current Tempus status (and optional sub-statuses) of an employee on behalf of a validator. The authenticated user must be a Tempus employee in the PBX and must hold correction scope over the target employee; otherwise a 403 is returned. A 404 is returned when no employee matches the given user_id in the tenant. A validator may assign any status, not only the ones in the employee's active layout.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
pbx_id path · string · uuid *
UUID of the PBX tenant.
accept header · string
example: application/json

Request body · required

Request schema
user_id*string · uuid
UUID of the target user whose status is being changed.
example: 550e8400-e29b-41d4-a716-446655440030
status_id*string · uuid
UUID of the Tempus status to assign.
example: 550e8400-e29b-41d4-a716-446655440031
sub_status_idsarray<string>
Optional UUIDs of sub-statuses to assign. Each must belong to the chosen status.
[]string · uuid
commentstring | null
Optional free-form comment recorded with the change.
length: 0–1000
example: Manual status set by validator

Responses

OK. The status that was applied.
Response schema
user_id*string · uuid
example: 550e8400-e29b-41d4-a716-446655440030
status_id*string · uuid
example: 550e8400-e29b-41d4-a716-446655440031
sub_status_ids*array<string>
[]string · uuid
Bad request. The status change failed; the body carries an `errors` array describing the reasons.
Response schema
messagestring
example: The status change failed.
errorsarray<string>
[]string
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Forbidden. The authenticated user is not part of the PBX, is not a Tempus employee in this tenant, or has no correction scope over the target employee.
Response schema
messagestring
example: You are not allowed to change this employee's status.
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
post https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/change-employee-status
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/change-employee-status' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/change-employee-status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/change-employee-status',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/change-employee-status', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
No request example provided.
{ … }
"user_id": "550e8400-e29b-41d4-a716-446655440030",
"status_id": "550e8400-e29b-41d4-a716-446655440031",
"sub_status_ids": [ … ]
"550e8400-e29b-41d4-a716-446655440032"
]
}
No example for this status.
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
No example for this status.
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57