Crm · Compensation
Add compensation claim note
Adds an internal note to a compensation claim. It takes an organization ID, a nullable mandate ID, a claim ID, and nonempty note content. It returns the new noteId. Notes are never shown to the contributor.
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 the
mandate.readpermission. - The caller needs the
compensationClaim.editpermission. - The claim must match the mandate access filter.
- The claim must match the assigned-only access filter.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
claimIdidrequired
Body
Content-Type: application/json
-
contentstringrequired1–4000 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/notes' \
--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/notes", {
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/notes', 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
Content-Type: application/json
-
noteIdstringexactly 6 characters
Response200
{
"noteId": "string"
}
What else happens
- The note is added to the claim's
notesincompensationClaims.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | Claim not found. | If no claim matches the claim ID, organization, and access filters, the endpoint returns HTTP 404 (NOT_FOUND) with the key compensation.errors.claimNotFound. |
Errors nearly every request can meet are listed under Errors.