Add a client card comment

Request

Creates a text comment for one Location client. Requires clients_access and client_comments_add_access. text must be nonblank and at most 255 characters. A URL in text is saved as text; it does not attach or upload the document at that URL.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

client_idnumberrequired

ID of a location client.

Example:123

Headers

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

Bodyapplication/jsonrequired

textstring, [ 1 .. 255 ] charactersrequired

Text of a comment for a client

Example:"Intake form: https://forms.example.com/123"

curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/clients/123/comments \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "Intake form: https://forms.example.com/123"
  }'

Responses

Created

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataobject(Object of model "Comment for a client")

Data for an existing comment for a client.

Example:

{
  "id": 123,
  "create_date": "2026-01-01T12:12:12-05:00",
  "update_date": "2026-01-01T12:12:12-05:00",
  "type": "default",
  "text": "Comment for a client",
  "files": [],
  "user": {
    "id": 123,
    "name": "John Johnson",
    "avatar": "https://api.alteg.io/images/avatar.png"
  },
  "is_editable": true
}

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": {
    "id": 123,
    "create_date": "2026-01-01T12:12:12-05:00",
    "update_date": "2026-01-01T12:12:12-05:00",
    "type": "default",
    "text": "Intake form: https://forms.example.com/123",
    "files": [],
    "user": { … },
    "is_editable": true
  },
  "meta": []
}