Add alert comment

Add a comment to an alert.

Comment Limits:

  • Maximum length: 500 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., @[email protected])

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

shipmentId of the shipment.

string
required

ID of the alert to comment on.

Body Params
string | null

The comment text to add to the alert. Required. Supports @mentions using either @{guid} or @{email} format. Invalid mentions will be preserved but excluded from notifications.

Headers
int32
required

ID of the account the request will be made in.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Invalid request - malformed IDs or validation errors

401

Unauthorized

404

Alert or shipment not found

500

Unexpected server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json