---
title: "Add shipment comment"
method: POST
path: "/public/v3/Shipments/{shipmentId}/comment"
tags: ["Shipments"]
---

# Add shipment comment

`POST /public/v3/Shipments/{shipmentId}/comment`

Add a comment to a shipment.

**Comment Limits:**
- **Maximum length:** 20000 characters
- **Maximum mentions:** 50 users per comment

**@Mentions:** Comments support mentioning users using two formats:
- **@{guid}** - Mention by user ID (e.g., `@a1b2c3d4-e5f6-7890-abcd-ef1234567890`)
- **@{email}** - Mention by email address (e.g., `@john.doe@example.com`)

Email mentions are automatically converted to GUID format when the user is found. Invalid mentions (non-existent users or users without shipment access) are preserved in the comment text but excluded from notifications. All invalid mentions are returned in the response `warnings.invalidMentions` array. Valid mentioned users receive email and in-app notifications.

## Path parameters

- `shipmentId` string, required

## Headers

- `x-tive-account-id` integer, required

## Request body

- ShipmentCommentRequest
  - `comment` string, nullable — The comment text to add to the shipment. Required. Supports @mentions using either @{guid} or @{email} format. Invalid mentions will be preserved but excluded from notifications.

## Response `201`

Shipment comment created successfully

- ShipmentCommentCreateResponse
  - `success` boolean
  - `message` string, nullable
  - `warnings` ShipmentCommentWarnings
    - `invalidMentions` string[], nullable
    - `warningMessage` string, nullable

## Other responses

- `400` — Invalid request - malformed IDs or validation errors
- `401` — Unauthorized
- `404` — Shipment not found
- `500` — Unexpected server error

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/revisions/9a8d869e3cdc/schema)