Skip to content
campaiDeveloper
campai.com

Crm · Compensation

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

Return compensation claim

Returns a submitted compensation claim to the contributor for changes, who declares any waiver again when resubmitting. The message is shown to the contributor, and an optional new deadline replaces the current one.

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
  • claimIdidrequired

Body

Content-Type: application/json

  • messagestringrequired

    1–2000 characters

  • deadlineAtstringrequirednullable
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/return' \
  --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.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.