{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-note-request-schema.json",
  "title": "NoteRequest",
  "description": "A single Note",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karbonhq-notes-api-openapi.yml#/components/schemas/NoteRequest",
  "required": [
    "AuthorEmailAddress",
    "Subject",
    "Body"
  ],
  "type": "object",
  "properties": {
    "Subject": {
      "type": "string",
      "description": "The subject line of the Note"
    },
    "Body": {
      "type": "string",
      "description": "The body of the Note. This property supports HTML."
    },
    "AuthorEmailAddress": {
      "type": "string",
      "description": "The email address of the Note's author"
    },
    "AssigneeEmailAddress": {
      "type": "string",
      "description": "The email address of the the Karbon user that the Note should be assigned to"
    },
    "DueDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date by which the actions on the note must be complete"
    },
    "TodoDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date for which the actions will be executed"
    },
    "Timelines": {
      "type": "array",
      "description": "The Timelines to which this note will be associated. If Notes are linked to a Work Item, the Timeline of the Client (associated with the Work Item) will show the Notes.",
      "items": {
        "type": "object",
        "properties": {
          "EntityType": {
            "type": "string",
            "description": "The type of entity this note will be linked to",
            "enum": [
              "WorkItem",
              "Contact",
              "Organization",
              "ClientGroup"
            ]
          },
          "EntityKey": {
            "type": "string",
            "description": "A Karbon-generated value to indicate the entity"
          }
        }
      }
    }
  }
}