Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/crm/compensation/contributors/{contactId}

Update contributor compensation

Sets up or updates a contributor contact’s compensation, including its active status, rates, individual allowance-limit amounts and Austrian social insurance number. It takes an organization ID and contact ID and returns no content.

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 compensationClaim.edit.
  • The caller needs contact:contributor.edit.
  • The contact lookup is restricted by the caller’s mandate access.

Request

Path parameters

  • organizationIdidrequired
  • contactIdidrequired

Body

Content-Type: application/json

  • activebooleanrequired
  • socialInsuranceNumberstringrequirednullable

    pattern ^\d{10}$

  • ratesid[]required

    at most 50 items

  • limitAmountsobject[]required

    at most 10 items

    2 properties
    • limitidrequired
    • amountintegerrequired

      0–9999999

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/contributors/YOUR_CONTACT_ID' \
  --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

No response body is specified.

What else happens

  • The endpoint updates the contributor’s compensation on the contact, preserving its existing deletedClaimPeriod.
  • The endpoint clears the Connect user organizations cache for the contact.

Errors

Other errors

StatusErrorWhen
400Only contributor contacts can receive compensation.If the contact is not found, is not a contributor, or has no contributor data, the endpoint returns BAD_REQUEST (400) with compensation.errors.notContributor.
400Choose one of the assigned rates.If a requested rate is neither active in the settings nor already assigned to the contributor, the endpoint returns BAD_REQUEST (400) with compensation.issues.invalidRate.
400Choose an allowance limit from the compensation settings.If an allowance limit is not in the compensation settings or appears more than once, the endpoint returns BAD_REQUEST (400) with compensation.errors.invalidLimit.
404Compensation claims are not set up for this organization.If compensation claims are not set up for the organization, the endpoint returns NOT_FOUND (404) with compensation.errors.notEnabled.

Errors nearly every request can meet are listed under Errors.