Crm ยท Compensation
Check compensation claim
Marks a submitted compensation claim as checked, with a review message, while leaving the claim submitted. A claim that is already checked is left unchanged. The endpoint returns no response body.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access is required.
- The caller needs
mandate.read. - The caller needs
compensationClaim.edit. - The claim lookup is subject to the caller's mandate access filter.
- The claim lookup is subject to the assigned-only access filter for
compensationClaim.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
claimIdidrequired
Body
Content-Type: application/json
-
messagestringrequirednullableat most 2000 characters
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/compensation/claims/YOUR_CLAIM_ID/check' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/claims/YOUR_CLAIM_ID/check", {
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/compensation/claims/YOUR_CLAIM_ID/check', 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
- For an unchecked submitted claim, the endpoint adds a
checkedreview with the time, actor and trimmed message. A blank or missing message is stored as null. - Checking an already checked claim adds no review.
- Checking leaves the claim's update time unchanged.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | This claim can no longer be changed. | If the claim is not already checked and the update does not match a submitted claim, the endpoint returns 400 with compensation.errors.notEditable. |
| 404 | Claim not found. | If the claim is not found, the endpoint returns 404 with compensation.errors.claimNotFound. |
Errors nearly every request can meet are listed under Errors.