What parameters does POST /V1/carts/mine/gift-message/:itemId accept?

This endpoint accepts 3 parameters: itemId (int) required; cartId (int) required; giftMessage (Magento\GiftMessage\Api\Data\MessageInterface) required.

Does POST /V1/carts/mine/gift-message/:itemId require authentication?

This endpoint requires a Bearer token. The `self` ACL means a customer token (when the caller owns the resource) or an admin token both work.

MageSmith

POSTGiftMessage · Magento 2.4.9 Self (customer or admin)

POST /V1/carts/mine/gift-message/:itemId

Q: What does the POST /V1/carts/mine/gift-message/:itemId endpoint do in Magento 2?

POST /V1/carts/mine/gift-message/:itemId is a Magento 2 REST endpoint in the GiftMessage module. Set the gift message for a specified item in a specified shopping cart. Requires a customer or admin Bearer token (whichever owns the resource).

POST /V1/carts/mine/gift-message/:itemId is a Magento 2 REST endpoint in the GiftMessage module. Set the gift message for a specified item in a specified shopping cart. Requires a customer or admin Bearer token (whichever owns the resource).

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

Returns

bool

Service contract

Magento\GiftMessage\Api\ItemRepositoryInterface::save

Authorization

Self — a customer Bearer token (when the caller owns the resource) or an admin token both work.

Path parameters

itemId int Required

The item ID.

Body parameters

cartId int Required

The cart ID.

giftMessage Magento\GiftMessage\Api\Data\MessageInterface Required

The gift message.

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> customer or admin token (whoever owns the resource)

Path

/V1/carts/mine/gift-message/{itemId}

Body

{
  "cartId": 0,
  "giftMessage": {
    "customer_id": 0,
    "extension_attributes": {},
    "gift_message_id": 0,
    "message": "",
    "recipient": "",
    "sender": ""
  }
}