Skip to content
campaiDeveloper
campai.com

Crm · Work hours

POST/{organizationId}/{mandateId}/crm/work-hours/accounts/{accountId}/notes

Add account note

Adds an internal note to a work hours account; notes are never shown to members. It takes an organization ID, a nullable mandate ID, an account ID and nonempty note content, and returns the new noteId.

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 workHours.edit.
  • A user limited to assigned work hours entries can add a note only if an entry for the account lists the user as a reviewer.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • accountIdidrequired

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/work-hours/accounts/YOUR_ACCOUNT_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

  • Adds the note to the account's notes.

Errors

Other errors

StatusErrorWhen
404Work hours account not found.If the account is not found for the organization and mandate, the endpoint returns HTTP 404 with key workHours.errors.accountNotFound.
404Work hours account not found.If a user limited to assigned entries has no entry for the account that lists them as a reviewer, the endpoint returns HTTP 404 with key workHours.errors.accountNotFound.

Errors nearly every request can meet are listed under Errors.