GOgoaugment
Track & Trace

Comment

v1 equivalent: comment (flat payload).

Sent when Augment sends or receives a carrier communication (email, phone, or text) that does not produce a distinct structured event like TRACKING_UPDATE, STOP_UPDATE or LOAD_CARRIER_UPDATE. Use this event to capture communication activity that does not map to a specific tracking or carrier update.

post/SEND_TMS_COMMENT

Request

Request body

idstring required

Unique event identifier (ULID)

workflow'TRACK_AND_TRACE' | 'CARRIER_SUPPORT' | 'POD_COLLECTION' | 'LOAD_BUILDING' | 'CARRIER_SELECTION' | 'SCHEDULING' | 'CUSTOMER_SUPPORT' | 'null' nullable required

The Augment workflow that produced this event, or null when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.

occurredAtstring date-time required

When the underlying activity occurred (ISO 8601)

loadNumberstring nullable required

Your load reference number

customerLoadInternalIdstring nullable required

Your internal load ID, if provided during load creation

eventType'SEND_TMS_COMMENT' required

Event name for an unstructured communication comment.

Response

Event acknowledged

Changes

No recorded changes to this operation across all 1 revision of this API.