note.md

Note

Example Usage

import { Note } from "attio-js/models/components/note.js";

let value: Note = {
  id: {
    workspaceId: "14beef7a-99f7-4534-a87e-70b564330a4c",
    noteId: "ff3f3bd4-40f4-4f80-8187-cd02385af424",
  },
  parentObject: "people",
  parentRecordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d",
  title: "Initial Prospecting Call Summary",
  contentPlaintext: "Introduction\n"
    + "Date and time of the call\n"
    + "Participants\n"
    + "Purpose of the call\n"
    + "Customer Background\n"
    + "Company overview (industry, size, location)\n"
    + "Key business challenges\n"
    + "Current software solutions (if any) and pain points",
  contentMarkdown: "# Introduction\n"
    + "Date and time of the call\n"
    + "Participants\n"
    + "Purpose of the call\n"
    + "\n"
    + "## Customer Background\n"
    + "- Company overview (industry, size, location)\n"
    + "- Key business challenges\n"
    + "- Current software solutions (if any) and pain points",
  createdByActor: {
    id: "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
    type: "workspace-member",
  },
  createdAt: "2022-11-21T13:22:49.061281000Z",
};

Fields

Field	Type	Required	Description	Example
id	components.NoteId	✔️	N/A
parentObject	string	✔️	The slug or ID of the parent object the note belongs to.	people
parentRecordId	string	✔️	The ID of the parent record the note belongs to.	891dcbfc-9141-415d-9b2a-2238a6cc012d
title	string	✔️	The note title. The title is plaintext only and has no formatting.	Initial Prospecting Call Summary
contentPlaintext	string	✔️	The plaintext representation of the note content. The line feed character \n represents new lines within the note content.	Introduction Date and time of the call Participants Purpose of the call Customer Background Company overview (industry, size, location) Key business challenges Current software solutions (if any) and pain points
contentMarkdown	string	✔️	The markdown representation of the note content with formatting applied based on block types and styles.	# Introduction Date and time of the call Participants Purpose of the call ## Customer Background - Company overview (industry, size, location) - Key business challenges - Current software solutions (if any) and pain points
createdByActor	components.NoteCreatedByActor	✔️	The actor that created this note.	{ "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }
createdAt	string	✔️	When the note was created.	2022-11-21T13:22:49.061281000Z