What parameters does POST /V1/creditmemo/:id/comments accept?

This endpoint accepts 1 parameter: entity (Magento\Sales\Api\Data\CreditmemoCommentInterface) required.

POSTSales · Magento 2.4.9 Admin · Magento_Sales::sales_creditmemo

POST /V1/creditmemo/:id/comments

Q: What does the POST /V1/creditmemo/:id/comments endpoint do in Magento 2?

POST /V1/creditmemo/:id/comments is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified entity. Requires an admin Bearer token with ACL Magento_Sales::sales_creditmemo.

Q: What does POST /V1/creditmemo/:id/comments return?

The endpoint returns Magento\Sales\Api\Data\CreditmemoCommentInterface.

Q: Does POST /V1/creditmemo/:id/comments require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Sales::sales_creditmemo.

POST /V1/creditmemo/:id/comments is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified entity. Requires an admin Bearer token with ACL Magento_Sales::sales_creditmemo.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

Magento\Sales\Api\Data\CreditmemoCommentInterface

Credit memo comment interface.

Service contract

Magento\Sales\Api\CreditmemoCommentRepositoryInterface::save

Authorization

Admin Bearer token with ACL:

Magento_Sales::sales_creditmemo

Body parameters

entity Magento\Sales\Api\Data\CreditmemoCommentInterface Required

The credit memo comment.

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

application/json

Content-Type

application/json

Authorization

Bearer <ACCESS_TOKEN> admin token with ACL: Magento_Sales::sales_creditmemo

Path

/V1/creditmemo/:id/comments

Body

{
  "entity": {
    "comment": "",
    "created_at": "",
    "entity_id": 0,
    "extension_attributes": {},
    "is_customer_notified": 0,
    "is_visible_on_front": 0,
    "parent_id": 0
  }
}