Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/{mandateId}/crm/compensation/claims/{claimId}/notes

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.read permission.
  • The caller needs the compensationClaim.edit permission.
  • 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

  • contentstringrequired

    1–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'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • noteIdstring

    exactly 6 characters

Response200
{
  "noteId": "string"
}

What else happens

  • The note is added to the claim's notes in compensationClaims.

Errors

Other errors

StatusErrorWhen
404Claim 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.