Crm · Work hours
Update work hours account
Updates an open work hours account's required hours or shifts and payer. An override can replace the calculated amount, exempt the holder with zero, or be cleared with null. Changes are recorded in the account history. The endpoint returns no value.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
mandate.read. - The caller needs
workHours.edit.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
accountIdidrequired
Body
Content-Type: application/json
-
overrideobjectnullable2 properties
-
requirednumberrequired0–999
-
reasonstringrequired2–200 characters
-
-
payerContactIdid
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/accounts/YOUR_ACCOUNT_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/accounts/YOUR_ACCOUNT_ID", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/accounts/YOUR_ACCOUNT_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
What else happens
- When
overrideis supplied, the account's override, required amount and missing amount are updated, and the change is added to its history. - When
payerContactIdis supplied and the contact is found, the account's payer is updated and the change is added to its history.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | This account is settled. Revoke the settlement first. | If the account is not open, the endpoint returns HTTP 400 with workHours.errors.accountSettled. |
| 400 | Shifts are counted in whole numbers. | If an override for an account measured in shifts has a non-integer required value, the endpoint returns HTTP 400 with workHours.errors.wholeShifts. |
| 400 | Choose who pays for this account. | If the supplied payerContactId does not identify a contact in the organization, the endpoint returns HTTP 400 with workHours.errors.payerRequired. |
| 404 | Work hours account not found. | If the account is not found for the organization and mandate, the endpoint returns HTTP 404 with workHours.errors.accountNotFound. |
| 404 | Work hours account not found. | If access is limited to assigned work hours entries and the caller is not a reviewer on an entry for the account, the endpoint returns HTTP 404 with workHours.errors.accountNotFound. |
Errors nearly every request can meet are listed under Errors.