/comments

Create a comment on an order, shipment, or tour. The comment body is a structured rich-text document whose top-level node is { "type": "doc", "content": [...] }; plain paragraphs with text nodes are sufficient for simple comments. Plaintext and mention/tag references are derived server-side. Omitted access rules default to operator-only visibility. The created comment is attributed to the calling API key.

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

Comment to create

string
enum
required
Allowed:
string
required
length ≥ 1
document
object
required
accessRules
object
string
attachmentDocumentIds
array of strings
length ≤ 10
attachmentDocumentIds
string
length between 1 and 128
Responses

400

Bad request

401

Unauthorized

404

Target object or referenced comment not found

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