Skip to content
HeyX API

Create Portfolio Comment

Required scope: portfolio_comment:create

Comments with one or more attachmentFileIds additionally require the exact portfolio_file:read scope.

Use this endpoint to add an internal memo or comment to a portfolio. The body uses the same reference and file-token format as the portfolio UI:

  • Entity reference: @[type:id:Display label]
  • File link: [filename.pdf](file:file-id)
  • Inline image: ![photo.jpg](file:file-id)

Supported UI reference types include member, problem, document, photo, internal_file, payment, refund, order, offer, action_request, and flow. Use IDs the API-key creator can access. Labels are display text, not an authorization boundary.

Upload files first, complete the upload, then include each file ID in attachmentFileIds. A file token controls where it renders in the body; the attachment list creates the canonical comment-to-file association.

Generated Reference
POST /public-api/publicapi.v1.Portfolio/CreatePortfolioComment

Creates an internal portfolio comment/memo.

Request CreatePortfolioCommentRequest
Response CreatePortfolioCommentResponse

CreatePortfolioCommentRequest

Field Type
portfolio_id string
body string
attachment_file_ids repeated string

CreatePortfolioCommentResponse

Field Type
comment PortfolioComment

Related Types

PortfolioComment

Field Type
id string
portfolio_id string
body string
attachments repeated PortfolioAttachment
created_at int64
updated_at int64

PortfolioAttachment

Field Type
id string
kind PortfolioAttachmentKind
visibility PortfolioFileVisibility
filename string
original_filename string
content_type string
size_bytes int64
description string
created_at int64
updated_at int64

Request

Section titled “Request”
{
  "portfolioId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
  "body": "Assigned to @[member:7fbbcbb2-c6d1-4b71-9864-d217494b6ef0:Alex Example]. See [inspection.pdf](file:cba8fef4-4fd2-4be6-af77-326e716ef130)",
  "attachmentFileIds": [
    "cba8fef4-4fd2-4be6-af77-326e716ef130"
  ]
}

Response

Section titled “Response”
{
  "comment": {
    "id": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c",
    "portfolioId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
    "body": "Imported note from ERP",
    "attachments": [
      {
        "id": "cba8fef4-4fd2-4be6-af77-326e716ef130",
        "kind": "PUBLIC_PORTFOLIO_ATTACHMENT_KIND_DOCUMENT"
      }
    ]
  }
}
HeyX API