Skip to main content

​
MCP tool: create_note

Creates a private note on any entity. Notes are automatically set to private visibility and are useful for internal documentation and team communication.

​
Example prompt

Create a note on ticket 71XNF90K10YBR86G1AN06KZJJFX40 with content "Customer requested urgent resolution"

​
Input parameters

NameTypeRequiredDescription
entityTypestringYesThe type of entity to add a note to (e.g., “ticket”, “accountActivity”, “note”, “task”)
entityIdstringYesThe ID of the entity to add a note to
contentstringNoThe plain text content of the note
attachmentIdsstring[]NoArray of attachment IDs to associate with the note
metadataobjectNoAny additional metadata (e.g., mentions, tags)

​
Response fields

Below are the fields you may see in the response:
FieldTypeDescription
idstringNote unique ID
contentstringPlain text content of the note
contentHtmlstringHTML formatted content
contentMarkdownstringMarkdown formatted content
contentJsonstringJSON formatted content for rich text
isEditedbooleanWhether the note has been edited
threadNamestringName of the comment thread
commentVisibilitystringAlways “private”
commentTypestringAlways “note”
isPinnedbooleanWhether the note is pinned
sourceEmailIdstringEmail ID if note came from email
metadataobjectAdditional metadata including mentions
createdAtstring (ISO8601)Creation timestamp
updatedAtstring (ISO8601)Last update timestamp
authorstringAuthor display name
authorAvatarUrlstringAuthor’s avatar URL
attachmentsarrayArray of attachment IDs
authorIdstringAuthor’s user ID
authorUserTypestringAuthor’s user type (e.g., ORG_ADMIN)
impersonatedUserEmailstringEmail of impersonated user
impersonatedUserNamestringName of impersonated user
impersonatedUserAvatarstringAvatar of impersonated user
deletedAtstringDeletion timestamp (null if not deleted)

​
Sample response

{
  "data": {
    "id": "PEDCR01K10RKS0142W6FR5AYJJMYJ",
    "content": "Internal note: Customer has been experiencing intermittent issues over the past month. Consider upgrading their account to premium support tier for better monitoring.",
    "contentHtml": "",
    "contentMarkdown": "Internal note: Customer has been experiencing intermittent issues over the past month. Consider upgrading their account to premium support tier for better monitoring.",
    "contentJson": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"left\"}}]}",
    "isEdited": false,
    "threadName": null,
    "commentVisibility": "private",
    "commentType": "note",
    "isPinned": false,
    "sourceEmailId": null,
    "metadata": {
      "mentions": []
    },
    "createdAt": "2025-07-25T12:19:31.410Z",
    "updatedAt": "2025-07-25T12:19:31.409Z",
    "author": "shakthi+1",
    "authorAvatarUrl": null,
    "attachments": [],
    "authorId": "UTH00SEXXFNVVN",
    "authorUserType": "ORG_ADMIN",
    "impersonatedUserEmail": null,
    "impersonatedUserName": null,
    "impersonatedUserAvatar": null,
    "deletedAt": null
  },
  "status": true,
  "message": "Comment created successfully!",
  "timestamp": "2025-07-25T12:19:31.442Z"
}