Contact Notes

Timeline notes on a contact.

4 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

`contact_notes.list`

GET

List a contact's notes (pinned first, then newest).

AI tool: contact_notes_list
API: GET /api/invoke/contact_notes.list

Input

Field	Type	Required
`contactId`	string	yes
`limit`	integer	—
`offset`	integer	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "type": "string",
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "contactId"
  ]
}

`contact_notes.create`

POST · mutating

Add a note to a contact.

AI tool: contact_notes_create
API: POST /api/invoke/contact_notes.create

Input

Field	Type	Required
`contactId`	string	yes
`body`	string	yes
`kind`	string	—
`pinned`	boolean	—
`occurredAt`	any	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "type": "string",
      "minLength": 1
    },
    "body": {
      "type": "string",
      "minLength": 1
    },
    "kind": {
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "occurredAt": {}
  },
  "required": [
    "contactId",
    "body"
  ]
}

`contact_notes.update`

PATCH · mutating

Update a contact note.

AI tool: contact_notes_update
API: PATCH /api/invoke/contact_notes.update

Input

Field	Type	Required	Description
`id`	string	yes
`patch`	object	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "patch": {
      "type": "object",
      "properties": {
        "body": {
          "type": "string"
        },
        "pinned": {
          "type": "boolean"
        },
        "kind": {
          "type": "string"
        },
        "occurredAt": {}
      }
    }
  },
  "required": [
    "id",
    "patch"
  ]
}

`contact_notes.delete`

DELETE · mutating

Delete a contact note.

AI tool: contact_notes_delete
API: DELETE /api/invoke/contact_notes.delete

Input

Field	Type	Required	Description
`id`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}