Create a note

v1.0.0

Creates a new note for a given record.

Required scopes: note:read-write, object_configuration:read, record_permission:read.

Input

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "content",
        "format",
        "parent_object",
        "parent_record_id",
        "title"
      ],
      "properties": {
        "content": {
          "type": "string",
          "description": "The main content of the note, formatted according to the value provided in the `format` field. Use `\\n` for line breaks in `plaintext`. For `markdown`, utilize the supported syntax elements to structure and style your note."
        },
        "created_at": {
          "type": "string",
          "description": "`created_at` will default to the current time. However, if you wish to backdate a note for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed."
        },
        "format": {
          "type": "string",
          "description": "Specify the format for the note's content. Choose from:\n- `plaintext`: Standard text format where `\\n` signifies a new line.\n- `markdown`: Enables rich text formatting using a subset of Markdown syntax:\n  - **Headings**: Levels 1-3 (`#`, `##`, `###`).\n  - **Lists**: Unordered (`-`, `*`, `+`) and ordered (`1.`, `2.`).\n  - **Text styles**: Bold (`**bold**` or `__bold__`), italic (`*italic*` or `_italic_`), strikethrough (`~~strikethrough~~`), and highlight (`==highlighted==`).\n  - **Links**: Standard Markdown links (`[link text](https://example.com)`).\n\n  *Note: While the Attio interface supports image embeds, they cannot currently be added or retrieved via the API's markdown format.*",
          "enum": [
            "plaintext",
            "markdown"
          ]
        },
        "meeting_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "An optional ID to associate this note with a meeting. If provided, the meeting must exist. Use `null` to explicitly set no meeting association."
        },
        "parent_object": {
          "type": "string",
          "description": "The ID or slug of the parent object the note belongs to."
        },
        "parent_record_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the parent record the note belongs to."
        },
        "title": {
          "type": "string",
          "description": "The note title. The title is plaintext only and has no formatting."
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "content_markdown",
        "content_plaintext",
        "created_at",
        "created_by_actor",
        "id",
        "meeting_id",
        "parent_object",
        "parent_record_id",
        "tags",
        "title"
      ],
      "properties": {
        "content_markdown": {
          "type": "string",
          "description": "The markdown representation of the note content. Supports a subset of markdown features including:\n- Headings (levels 1-3 only with `#`, `##`, `###`)\n- Unordered lists (`-`, `*`, `+`)\n- Ordered lists (`1.`, `2.`, etc.)\n- Text styling: `**bold**`, `*italic*`, `~~strikethrough~~`, `==highlighted==`\n- Links: `[link text](https://example.com)`\n\nNote that note images are not returned as part of the markdown API representation."
        },
        "content_plaintext": {
          "type": "string",
          "description": "The plaintext representation of the note content. The line feed character `\\n` represents new lines within the note content."
        },
        "created_at": {
          "type": "string",
          "description": "When the note was created."
        },
        "created_by_actor": {
          "type": "object",
          "description": "The actor that created this note.",
          "properties": {
            "id": {
              "type": "string",
              "description": "An ID to identify the actor."
            },
            "type": {
              "type": "string",
              "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
              "enum": [
                "api-token",
                "workspace-member",
                "system",
                "app"
              ]
            }
          }
        },
        "id": {
          "type": "object",
          "required": [
            "note_id",
            "workspace_id"
          ],
          "properties": {
            "note_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the note."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the workspace the note belongs to."
            }
          }
        },
        "meeting_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of the meeting associated with this note, or null if no meeting is associated."
        },
        "parent_object": {
          "type": "string",
          "description": "The slug or ID of the parent object the note belongs to."
        },
        "parent_record_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the parent record the note belongs to."
        },
        "tags": {
          "type": "array",
          "description": "An array of records or workspace members that are @-tagged in the note content.",
          "items": {
            "type": "object"
          }
        },
        "title": {
          "type": "string",
          "description": "The note title. The title is plaintext only and has no formatting."
        }
      }
    }
  }
}