Add a person note

Request#

POST /api/v1/people/{record}/notes

Requires people:events. See token permissions. Every listed permission is required for this endpoint.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json. Send request bodies as JSON with Content-Type: application/json, or as multipart/form-data when uploading attachments. This workflow write requires Idempotency-Key. Reuse the same key only when retrying the same action.

record is the numeric person ID in your token’s organization.

Query parameters#

This endpoint does not use query parameters.

Request body#

Example#

Set ASSETCENTER_API_TOKEN as described in the quick start. Replace example record and option IDs with values from your organization. Set IDEMPOTENCY_KEY to a new UUID for this action; keep it for retries.

curl --request POST "https://my.assetcenter.app/api/v1/people/123/notes" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data '{"description":"Inventory verified by our integration."}'

To upload files, send multipart/form-data instead of JSON. Let curl set the Content-Type header, and send booleans as 1 or 0.

curl --globoff --request POST "https://my.assetcenter.app/api/v1/people/123/notes" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --form "description=Inspection completed." \
  --form "comments[]=Photos taken on site." \
  --form "attachments[]=@report.pdf"

Response#

201 Created. Illustrative response structure. Event arrays, to-do/space values, and current state depend on the action and the record.

{
  "data": {
    "resource": "people",
    "record_id": 123,
    "person_location_event_ids": [
      901
    ],
    "asset_event_ids": [],
    "subscription_event_ids": [],
    "todo": null,
    "space": null,
    "state": {
      "status": "active"
    },
    "attachments_count": 0,
    "comments_count": 0
  }
}

Behavior and constraints#

The note is recorded in the timeline. Input is plain text and is escaped for display. Use the timeline with the record’s Read permission to inspect it.

Attachments and comments are saved on the note, and attachments_count and comments_count in the response confirm how many were added. Files are stored privately and count toward your plan’s storage; a request that would exceed it returns 422 with a plan error and changes nothing. If any file fails to save, the whole action is rolled back. An Idempotency-Key retry must resend the same files; a different file is a different request and returns 409.

Errors#

401 means the token is missing, expired, revoked, or not a customer API token. 403 means a required permission or administrator access is missing. 404 means the record or child record is unavailable in this organization. 422 identifies invalid or unsupported input; inspect the errors object when present. 409 indicates a conflicting state or concurrent change; inspect the message and refresh the record before deciding how to proceed. Reusing an idempotency key with a different method, path, or body also returns 409. 429 means a rate limit was reached. See error handling and rate limits.