Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/{mandateId}/crm/compensation/claims/remind

Remind about open claims

Sends a reminder to the contributors of up to 100 unsubmitted compensation claims matching the filters, property filter and selection.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • compensationClaim.edit

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • yearinteger

    2000–2999

  • periodFromstring
  • userFilterstringnullable

    A stringified json object representing a property filter

  • idsid[]

    at most 1000 items

  • excludeIdsid[]

    at most 1000 items

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/remind' \
  --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

  • remindedinteger
Response200
{
  "reminded": 1
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.