Add a note to an appointment.

POSThttps://app.softsolz.uk/api/v1/services/appointments/appointments/{id}/notes

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

bodystringrequired

Text content.

visibilitystring

Whether this is internal only or visible to the customer.

Response

Response Body

idstringNote id. A whole number sent as a string.

appointment_idstring | nullAppointment the note is on. A whole number sent as a string, or null.

customer_idstring | nullCustomer the note is on, when it was written against a customer. A whole number sent as a string, or null.

bodystringNote text.

visibilitystringinternal is for the team only, customer can be shown to the customer.

attachmentsarray of objectsFiles attached to the note.

author_user_idinteger | nullWorkspace member who wrote it. Null for notes added through the API.

created_atstringWhen the note was written.

updated_atstringWhen the note was last changed.

tenant_idstringThe workspace this record belongs to.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/appointments/appointments/{id}/notes \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "body": "your-body"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "id": "316",
    "appointment_id": "650",
    "customer_id": null,
    "body": "Customer asked for a morning slot next time.",
    "visibility": "internal",
    "attachments": [],
    "author_user_id": null,
    "created_at": "2026-10-01T17:42:56.469Z",
    "updated_at": "2026-10-01T17:42:56.469Z",
    "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61"
  }
}