Merge · Schema

Note

# 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
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
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.
remote_updated_at	stringnull	When the third party's lead was updated.
remote_created_at	stringnull	When the third party's lead was created.
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove
field_mappings	object
remote_data	arraynull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Note",
  "title": "Note",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "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."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's lead was updated."
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's lead was created."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/NoteFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "description": "# The Note Object\n### Description\nThe `Note` object is used to represent a note on another object.\n### Usage Example\nTODO"
}