Follow up in six weeks.
", "is_pinned": false, "subject_id": "00000000-0000-4000-8000-000000000004", "subject_type": "patient" } ``` ## Response `201` The requested `Note`. - `object` - `attachments` (`array`) - The files attached to the note. - `items` (`object`) - `download_url` (`string | null`) - format: `uri`; The short-lived signed download URL for the attachment. Null while the malware scan is not complete. - `filename` (`string | null`) - The original filename of the attachment. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `author` (`any`) - The staff member or Developer Platform project that created the note. - `content` (`string | null`) - The sanitized HTML body of the note. - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `is_pinned` (`boolean`) - Whether the note is pinned for prominent display. - `links` (`object`) - URLs to related resources. Only the subject's link (`booking` or `patient`) is present on show/index/webhook responses. `remote_file_import_batch` is present on create/update responses when at least one attachment was submitted. - `booking` (`string | null`) - format: `uri`; The full URL of a related resource. - `patient` (`string | null`) - format: `uri`; The full URL of a related resource. - `remote_file_import_batch` (`string`) - format: `uri`; The full URL of a related resource. - `object` (`any`) - Discriminator value emitted at `object`. - `remote_file_import_batch_id` (`string`) - format: `uuid`; The identifier of the remote file import batch created for uploaded attachments. Set on create and update responses when at least one attachment was submitted. - `subject_id` (`string | null`) - format: `uuid`; The identifier of the patient or booking that the note concerns. - `subject_type` (`string | null`) - enum: `null`, `patient`, `booking`; The type of resource that the note concerns. - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. ### Example ```json { "id": "e15af05d-2be0-459d-88c2-19cf18b3d0ff", "object": "note", "attachments": [ { "id": "f631636b-32e2-41be-8e4f-0a34ee0d5d59", "download_url": "https://files.example.invalid/document.pdf?signature=test", "filename": "referral-letter.pdf" } ], "author": { "id": "af02fa53-0af3-48ab-83b5-82488923e84f", "object": "staff_member", "created_at": "2026-01-01T09:00:00Z", "email": "alex.morgan@example.com", "first_name": "Alex", "last_name": "Morgan", "links": { "self": "https://api.carebit.co/v1/staff_members/af02fa53-0af3-48ab-83b5-82488923e84f" }, "name": "Initial consultation", "title": "Dr", "updated_at": "2026-01-01T09:00:00Z" }, "content": "The Patient reports improved symptoms.
", "created_at": "2026-01-01T09:00:00Z", "is_pinned": true, "links": { "booking": "https://api.carebit.co/v1/bookings/92a3b4c5-d6e7-4f01-8234-56789abcdef0", "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678", "remote_file_import_batch": "https://api.carebit.co/v1/remote_file_import_batches/ebc38802-f219-4c7b-8136-8e963a0c69e0" }, "remote_file_import_batch_id": "ebc38802-f219-4c7b-8136-8e963a0c69e0", "subject_id": "1460f5ec-fe45-4f44-80d7-8a3b86ef2864", "subject_type": null, "updated_at": "2026-01-01T09:00:00Z" } ``` ## Response `400` The `Idempotency-Key` header is missing (`idempotency_key_required`) or exceeds 255 characters (`idempotency_key_too_long`). - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `401` The access token is missing, invalid, expired, or revoked. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `403` The access token lacks the required scope, or the project is disabled. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `404` Error response. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `409` A concurrent request holds the idempotency lease (`idempotency_conflict`). Retry after the delay indicated by `Retry-After`. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `422` The `Idempotency-Key` was previously used with a different request body (`idempotency_key_reused`), or the request body failed validation. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Response `429` Too many requests. Retry after the delay indicated by `Retry-After`. - `object` - `error` (`object`) - The structured details that describe why the request failed. - `code` (`string`) - The machine-readable error code. - `errors` (`array | null`) - Additional errors from a failed validation. - `items` (`object`) - `code` (`string`) - The machine-readable code for this validation error. - `message` (`string`) - A message that explains this validation error. - `param` (`string | null`) - The name of the parameter that caused this validation error, when known. - `message` (`string`) - A message that explains the error and how to resolve it. - `param` (`string | null`) - The name of the parameter that caused the error, when known. - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error. ### Example ```json { "error": { "code": "resource_missing", "errors": [ { "code": "resource_missing", "message": "The requested resource was not found.", "param": "patient_id" } ], "message": "The requested resource was not found.", "param": "patient_id", "type": "authentication_error" } } ``` ## Code samples ```bash curl -X POST "https://api.carebit.co/v1/notes" \ -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "content": "Follow up in six weeks.
", "is_pinned": false, "subject_id": "00000000-0000-4000-8000-000000000004", "subject_type": "patient" }' ``` ```javascript const response = await fetch("https://api.carebit.co/v1/notes", { method: "POST", headers: { Authorization: `Bearer ${process.env.CAREBIT_ACCESS_TOKEN}`, "Content-Type": "application/json", "Idempotency-Key": crypto.randomUUID(), }, body: JSON.stringify({ "content": "Follow up in six weeks.
", "is_pinned": false, "subject_id": "00000000-0000-4000-8000-000000000004", "subject_type": "patient" }), }); if (!response.ok) { throw new Error(`Carebit API error: ${response.status}`); } const data = await response.json(); ``` ```python import os import requests import uuid response = requests.post( "https://api.carebit.co/v1/notes", headers={ "Authorization": f"Bearer {os.environ['CAREBIT_ACCESS_TOKEN']}", "Idempotency-Key": str(uuid.uuid4()), }, json={ "content": "Follow up in six weeks.
", "is_pinned": False, "subject_id": "00000000-0000-4000-8000-000000000004", "subject_type": "patient" } ) response.raise_for_status() data = response.json() ``` ```ruby require "httparty" require "json" require "securerandom" response = HTTParty.post( "https://api.carebit.co/v1/notes", headers: { "Authorization" => "Bearer #{ENV.fetch("CAREBIT_ACCESS_TOKEN")}", "Idempotency-Key" => SecureRandom.uuid, "Content-Type" => "application/json" }, body: { "content" => "Follow up in six weeks.
", "is_pinned" => false, "subject_id" => "00000000-0000-4000-8000-000000000004", "subject_type" => "patient" }.to_json ) raise "Carebit API error: #{response.code}" unless response.success? data = response.parsed_response ``` ```php post("https://api.carebit.co/v1/notes", [ "headers" => [ "Authorization" => "Bearer " . getenv("CAREBIT_ACCESS_TOKEN"), "Idempotency-Key" => bin2hex(random_bytes(16)), ], "json" => [ "content" => "Follow up in six weeks.
", "is_pinned" => false, "subject_id" => "00000000-0000-4000-8000-000000000004", "subject_type" => "patient" ] ]); $data = json_decode((string) $response->getBody(), true, flags: JSON_THROW_ON_ERROR); ```