Merge · Schema

NoteRequest

# The Note Object ### Description The `Note` object is used to represent a note on another object. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
owner stringnull The note's owner.
content stringnull The note's content.
contact stringnull The note's contact.
account stringnull The note's account.
opportunity stringnull The note's opportunity.
note_url stringnull The note's URL in the remote system.
integration_params objectnull
linked_account_params objectnull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-noterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NoteRequest",
  "title": "NoteRequest",
  "type": "object",
  "properties": {
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The note's owner."
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "The note's content."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The note's contact."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The note's account."
    },
    "opportunity": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The note's opportunity."
    },
    "note_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The note's URL in the remote system."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Note Object\n### Description\nThe `Note` object is used to represent a note on another object.\n### Usage Example\nTODO"
}