v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB

Shipments

Add shipment 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.

post/public/v3/Shipments/{shipmentId}/comment

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

commentstring 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

Shipment comment created successfully

successboolean

messagestring nullable