Skip to content
/
Edit Note

Edit Note

Request

Security
x-api-key and a-api-key
Path
appointment_idintegerrequired
Bodyapplication/json
app_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example:"2026-01-01T12:05:30"
practitioner_idinteger
business_idinteger
durationinteger, [ 5 .. 1440 ]

Must be between 5 and 1440 and divisible by 5.

descriptionstring
font_colourstring

Hex colour in the format #RRGGBB.

Example:"#000000"
bg_colourstring

Hex colour in the format #RRGGBB.

Example:"#FFD700"
notesstring
column_numberinteger
Default:1
widthinteger
Default:1
resource_idsArray of integers
Example:
[
  1,
  2
]
PATCH
/note/{appointment_id}
curl -i -X PATCH \
  'https://api.pracsuite.com/v1/note/{appointment_id}' \
  -H 'Content-Type: application/json' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "app_time": "2026-01-01T12:05:30",
    "practitioner_id": 0,
    "business_id": 0,
    "duration": 5,
    "description": "string",
    "font_colour": "#000000",
    "bg_colour": "#FFD700",
    "notes": "string",
    "column_number": 1,
    "width": 1,
    "resource_ids": [
      1,
      2
    ]
  }'

Responses

Successful

Bodyapplication/json
row_numintegerread-only
total_rowsintegerread-only
appointment_idinteger
app_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example:"2026-01-01T12:05:30"
practitioner_idinteger
business_idinteger
durationinteger, [ 5 .. 1440 ]

Must be between 5 and 1440 and divisible by 5.

column_numberinteger
Default:1
widthinteger
Default:1
categorystring
Example:"Note"
notesstring
descriptionstring
createdstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
modifiedstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
font_colourstring

Hex colour in the format #RRGGBB.

Example:"#000000"
bg_colourstring

Hex colour in the format #RRGGBB.

Example:"#FFD700"
resource_idsArray of integers
Response
{
  "row_num": 0,
  "total_rows": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/note/1",
    "resources": "https://api.pracsuite.com/v1/note/1/resource"
  },
  "appointment_id": 0,
  "app_time": "2026-01-01T12:05:30",
  "practitioner_id": 0,
  "business_id": 0,
  "duration": 5,
  "column_number": 1,
  "width": 1,
  "category": "Note",
  "notes": "string",
  "description": "string",
  "created": "2020-09-12T11:09:42.687393Z",
  "modified": "2020-09-12T11:09:42.687393Z",
  "font_colour": "#000000",
  "bg_colour": "#FFD700",
  "resource_ids": [
    0
  ]
}