[{"data":1,"prerenderedAt":1226},["ShallowReactive",2],{"changelog:off-route":3,"\u002Fmessages":4,"docs-nav":1168},null,{"id":5,"title":6,"body":7,"cards":3,"description":1156,"extension":1157,"group":1158,"hero":3,"icon":1159,"meta":1160,"navTitle":6,"navigation":1161,"order":1162,"path":1163,"seo":1164,"sitemap":1165,"stem":13,"__hash__":1167},"docs\u002Fmessages.md","Messages",{"type":8,"value":9,"toc":1140},"minimark",[10,14,18,23,85,103,120,128,131,135,171,381,410,413,554,558,564,641,654,666,669,672,676,682,715,737,741,748,754,801,812,823,827,869,872,875,901,910,921,924,928,938,982,985,989,1003,1010,1014,1050,1054,1124,1128,1136],[11,12,6],"h1",{"id":13},"messages",[15,16,17],"p",{},"A shipment and an inquiry each have conversations, as they do in the app. You can\nread them from your own systems, post into them as the user your token belongs to,\nand mark them read, so the whole conversation lives in your own timeline and your\nteam can answer without opening the app.",[19,20,22],"h2",{"id":21},"the-conversations","The conversations",[24,25,26,42],"table",{},[27,28,29],"thead",{},[30,31,32,36,39],"tr",{},[33,34,35],"th",{},"Conversation",[33,37,38],{},"Paths",[33,40,41],{},"With",[43,44,45,60,72],"tbody",{},[30,46,47,51,57],{},[48,49,50],"td",{},"Chat of a shipment",[48,52,53],{},[54,55,56],"code",{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fchat\u002Fmessage",[48,58,59],{},"Cargoplot's service team",[30,61,62,65,70],{},[48,63,64],{},"Chat of an inquiry",[48,66,67],{},[54,68,69],{},"\u002Fv1\u002Finquiry\u002F{inquiry}\u002Fchat\u002Fmessage",[48,71,59],{},[30,73,74,77,82],{},[48,75,76],{},"Customs of a shipment",[48,78,79],{},[54,80,81],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fcustoms\u002Fmessage",[48,83,84],{},"The shipment's customs agent",[15,86,87,88,91,92,95,96,99,100,102],{},"Each path reads with ",[54,89,90],{},"GET"," and posts with ",[54,93,94],{},"POST",". Marking read has a path of its\nown, ",[54,97,98],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fchat\u002Fread"," and the same for the inquiry's chat and\nthe shipment's customs conversation, which takes a ",[54,101,94],{},".",[15,104,105,108,109,112,113,116,117,102],{},[54,106,107],{},"{shipment}"," and ",[54,110,111],{},"{inquiry}"," take the Cargoplot reference or the numeric id, as\nevery other endpoint does. An inquiry has no customs conversation, so a customs\npath under ",[54,114,115],{},"\u002Fv1\u002Finquiry"," answers ",[54,118,119],{},"404",[15,121,122,123,127],{},"A shipment booked from an inquiry has the inquiry's reference, and a\nconversation belongs to a reference. The chat of the inquiry and the chat of its\nshipment are therefore ",[124,125,126],"strong",{},"one conversation",", and both paths return it.",[15,129,130],{},"Each list returns one conversation. The customs conversation appears in the app\nonce it holds a message; until then its list is an empty page, not an error.",[19,132,134],{"id":133},"reading-a-conversation","Reading a conversation",[136,137,143],"pre",{"className":138,"code":139,"filename":140,"language":141,"meta":142,"style":142},"language-bash shiki shiki-themes github-dark github-dark","curl -H 'X-Cargoplot-Key: \u003Ctoken>' \\\n  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage?limit=2'\n","GET \u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage","bash","",[54,144,145,165],{"__ignoreMap":142},[146,147,150,154,158,162],"span",{"class":148,"line":149},"line",1,[146,151,153],{"class":152},"sFR8T","curl",[146,155,157],{"class":156},"s8ozJ"," -H",[146,159,161],{"class":160},"s4wv1"," 'X-Cargoplot-Key: \u003Ctoken>'",[146,163,164],{"class":156}," \\\n",[146,166,168],{"class":148,"line":167},2,[146,169,170],{"class":160},"  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage?limit=2'\n",[136,172,176],{"className":173,"code":174,"language":175,"meta":142,"style":142},"language-json shiki shiki-themes github-dark github-dark","{\n  \"messages\": [\n    {\n      \"id\": \"d0qhk3bb1d1m1c7ehqkg\",\n      \"reference\": \"C2AE-XEE1\",\n      \"conversation\": \"CONVERSATION_CHAT\",\n      \"text\": \"Your container is released and will be delivered tomorrow.\",\n      \"send_time\": \"2026-10-01T08:00:00Z\",\n      \"edit_time\": null,\n      \"author\": { \"kind\": \"AUTHOR_KIND_SERVICE\", \"name\": \"Joan Clarke\" },\n      \"channel\": \"CHANNEL_APP\",\n      \"read\": false,\n      \"attachments\": []\n    }\n  ],\n  \"cursor\": { \"after\": \"eyJ...\" }\n}\n","json",[54,177,178,184,192,198,213,226,239,252,265,278,309,322,335,344,350,356,375],{"__ignoreMap":142},[146,179,180],{"class":148,"line":149},[146,181,183],{"class":182},"suv1-","{\n",[146,185,186,189],{"class":148,"line":167},[146,187,188],{"class":156},"  \"messages\"",[146,190,191],{"class":182},": [\n",[146,193,195],{"class":148,"line":194},3,[146,196,197],{"class":182},"    {\n",[146,199,201,204,207,210],{"class":148,"line":200},4,[146,202,203],{"class":156},"      \"id\"",[146,205,206],{"class":182},": ",[146,208,209],{"class":160},"\"d0qhk3bb1d1m1c7ehqkg\"",[146,211,212],{"class":182},",\n",[146,214,216,219,221,224],{"class":148,"line":215},5,[146,217,218],{"class":156},"      \"reference\"",[146,220,206],{"class":182},[146,222,223],{"class":160},"\"C2AE-XEE1\"",[146,225,212],{"class":182},[146,227,229,232,234,237],{"class":148,"line":228},6,[146,230,231],{"class":156},"      \"conversation\"",[146,233,206],{"class":182},[146,235,236],{"class":160},"\"CONVERSATION_CHAT\"",[146,238,212],{"class":182},[146,240,242,245,247,250],{"class":148,"line":241},7,[146,243,244],{"class":156},"      \"text\"",[146,246,206],{"class":182},[146,248,249],{"class":160},"\"Your container is released and will be delivered tomorrow.\"",[146,251,212],{"class":182},[146,253,255,258,260,263],{"class":148,"line":254},8,[146,256,257],{"class":156},"      \"send_time\"",[146,259,206],{"class":182},[146,261,262],{"class":160},"\"2026-10-01T08:00:00Z\"",[146,264,212],{"class":182},[146,266,268,271,273,276],{"class":148,"line":267},9,[146,269,270],{"class":156},"      \"edit_time\"",[146,272,206],{"class":182},[146,274,275],{"class":156},"null",[146,277,212],{"class":182},[146,279,281,284,287,290,292,295,298,301,303,306],{"class":148,"line":280},10,[146,282,283],{"class":156},"      \"author\"",[146,285,286],{"class":182},": { ",[146,288,289],{"class":156},"\"kind\"",[146,291,206],{"class":182},[146,293,294],{"class":160},"\"AUTHOR_KIND_SERVICE\"",[146,296,297],{"class":182},", ",[146,299,300],{"class":156},"\"name\"",[146,302,206],{"class":182},[146,304,305],{"class":160},"\"Joan Clarke\"",[146,307,308],{"class":182}," },\n",[146,310,312,315,317,320],{"class":148,"line":311},11,[146,313,314],{"class":156},"      \"channel\"",[146,316,206],{"class":182},[146,318,319],{"class":160},"\"CHANNEL_APP\"",[146,321,212],{"class":182},[146,323,325,328,330,333],{"class":148,"line":324},12,[146,326,327],{"class":156},"      \"read\"",[146,329,206],{"class":182},[146,331,332],{"class":156},"false",[146,334,212],{"class":182},[146,336,338,341],{"class":148,"line":337},13,[146,339,340],{"class":156},"      \"attachments\"",[146,342,343],{"class":182},": []\n",[146,345,347],{"class":148,"line":346},14,[146,348,349],{"class":182},"    }\n",[146,351,353],{"class":148,"line":352},15,[146,354,355],{"class":182},"  ],\n",[146,357,359,362,364,367,369,372],{"class":148,"line":358},16,[146,360,361],{"class":156},"  \"cursor\"",[146,363,286],{"class":182},[146,365,366],{"class":156},"\"after\"",[146,368,206],{"class":182},[146,370,371],{"class":160},"\"eyJ...\"",[146,373,374],{"class":182}," }\n",[146,376,378],{"class":148,"line":377},17,[146,379,380],{"class":182},"}\n",[15,382,383,384,387,388,392,393,396,397,400,401,406,407,409],{},"Messages come ",[124,385,386],{},"newest first",", so the latest ",[389,390,391],"em",{},"N"," are ",[54,394,395],{},"limit=N",". Pass\n",[54,398,399],{},"order=ORDER_ASC"," to read forward. The page size and the cursors work as on every\n",[402,403,405],"a",{"href":404},"\u002Fpagination","list",", with one difference: a conversation can be empty, so an\nempty ",[54,408,13],{}," list is a normal answer.",[15,411,412],{},"Your own messages are listed, so the whole conversation is in one place.",[24,414,415,424],{},[27,416,417],{},[30,418,419,422],{},[33,420,421],{},"Field",[33,423],{},[43,425,426,436,446,463,473,492,506,523,537],{},[30,427,428,433],{},[48,429,430],{},[54,431,432],{},"id",[48,434,435],{},"The message's identifier: stable, and the same wherever the message appears. It is what marking read takes.",[30,437,438,443],{},[48,439,440],{},[54,441,442],{},"reference",[48,444,445],{},"The reference of the shipment or inquiry.",[30,447,448,453],{},[48,449,450],{},[54,451,452],{},"conversation",[48,454,455,458,459,462],{},[54,456,457],{},"CONVERSATION_CHAT"," or ",[54,460,461],{},"CONVERSATION_CUSTOMS",", for timelines that merge the two.",[30,464,465,470],{},[48,466,467],{},[54,468,469],{},"text",[48,471,472],{},"The message as plain text.",[30,474,475,483],{},[48,476,477,297,480],{},[54,478,479],{},"send_time",[54,481,482],{},"edit_time",[48,484,485,486,488,489,491],{},"When it was sent, and when it was last edited in the app. ",[54,487,482],{}," is ",[54,490,275],{}," for a message that never was.",[30,493,494,499],{},[48,495,496],{},[54,497,498],{},"author",[48,500,501,502,102],{},"Who wrote it: see ",[402,503,505],{"href":504},"#authors","authors",[30,507,508,513],{},[48,509,510],{},[54,511,512],{},"channel",[48,514,515,518,519,522],{},[54,516,517],{},"CHANNEL_APP"," for a message written in Cargoplot, whether in the app, through this API or by an AI assistant, and ",[54,520,521],{},"CHANNEL_EMAIL"," for one that arrived by email.",[30,524,525,530],{},[48,526,527],{},[54,528,529],{},"read",[48,531,532,533,102],{},"Whether you have read it: see ",[402,534,536],{"href":535},"#read-and-unread","read and unread",[30,538,539,544],{},[48,540,541],{},[54,542,543],{},"attachments",[48,545,546,547,108,550,553],{},"The ",[54,548,549],{},"file_name",[54,551,552],{},"media_type"," of each file sent with the message.",[555,556,557],"h3",{"id":505},"Authors",[15,559,560,563],{},[54,561,562],{},"author.kind"," says on which side of the conversation a message was written.",[24,565,566,586],{},[27,567,568],{},[30,569,570,573,576,581],{},[33,571,572],{},"Kind",[33,574,575],{},"Who",[33,577,578],{},[54,579,580],{},"name",[33,582,583],{},[54,584,585],{},"user_id",[43,587,588,610,626],{},[30,589,590,595,598,601],{},[48,591,592],{},[54,593,594],{},"AUTHOR_KIND_ORGANIZATION",[48,596,597],{},"A member of your own organization",[48,599,600],{},"The person",[48,602,603,604,606,607],{},"The person's ",[54,605,432],{}," for ",[54,608,609],{},"GET \u002Fv1\u002Fuser\u002F{user}",[30,611,612,617,620,623],{},[48,613,614],{},[54,615,616],{},"AUTHOR_KIND_SERVICE",[48,618,619],{},"The service side of the conversation",[48,621,622],{},"A member of Cargoplot's service team by name, a partner on that side as the service team",[48,624,625],{},"Absent",[30,627,628,633,636,639],{},[48,629,630],{},[54,631,632],{},"AUTHOR_KIND_EXTERNAL",[48,634,635],{},"A user of another client of Cargoplot, or an email sender Cargoplot could not match to a user or an organization",[48,637,638],{},"The person's name, or the name in the From header",[48,640,625],{},[15,642,643,644,646,647,649,650,653],{},"On the service side, a forwarder, a customs agent or any other partner who writes in\nthe conversation shows as the service team, never under their own name or\norganization. A user of another client who writes in it shows as external: by their own\nname, with no organization and no ",[54,645,585],{},". No field of a message carries an email address.\nThe ",[54,648,469],{}," of an emailed message can contain addresses that were written in it, such as the\n",[54,651,652],{},"CC:"," lines Cargoplot puts at the top of one.",[15,655,656,657,659,660,662,663,665],{},"The kind follows the organization the author belonged to when the message was\nsent. A colleague who has left still shows as ",[54,658,594],{},", and their\n",[54,661,585],{}," may no longer be found at ",[54,664,609],{},". An author of an organization\nthat has been deleted since shows as the service team.",[555,667,668],{"id":543},"Attachments",[15,670,671],{},"A message lists the name and the media type of each file. The files themselves\ncannot be downloaded through the API: open them in the app.",[19,673,675],{"id":674},"polling-for-new-messages","Polling for new messages",[15,677,678,679,681],{},"To follow a conversation, filter on ",[54,680,479],{},":",[136,683,685],{"className":138,"code":684,"filename":140,"language":141,"meta":142,"style":142},"curl -H 'X-Cargoplot-Key: \u003Ctoken>' -G \\\n  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage' \\\n  --data-urlencode 'filter=send_time >= \"2026-10-01T08:00:00Z\"'\n",[54,686,687,700,707],{"__ignoreMap":142},[146,688,689,691,693,695,698],{"class":148,"line":149},[146,690,153],{"class":152},[146,692,157],{"class":156},[146,694,161],{"class":160},[146,696,697],{"class":156}," -G",[146,699,164],{"class":156},[146,701,702,705],{"class":148,"line":167},[146,703,704],{"class":160},"  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage'",[146,706,164],{"class":156},[146,708,709,712],{"class":148,"line":194},[146,710,711],{"class":156},"  --data-urlencode",[146,713,714],{"class":160}," 'filter=send_time >= \"2026-10-01T08:00:00Z\"'\n",[15,716,717,719,720,723,724,726,727,730,731,733,734,736],{},[54,718,479],{}," takes an RFC 3339 time with ",[54,721,722],{},">="," only, and the value is quoted. Start\neach poll from the last ",[54,725,479],{}," you saw ",[124,728,729],{},"minus a few minutes",", and skip the\nmessages whose ",[54,732,432],{}," you already have. A message is listed a moment after it is\nsent, so one that is sent while you poll can carry a ",[54,735,479],{}," from before the\nstart of your poll. The order does not matter for polling.",[19,738,740],{"id":739},"read-and-unread","Read and unread",[15,742,743,744,747],{},"Every message says whether ",[124,745,746],{},"you"," have read it, meaning the user your token\nbelongs to. A message is read when it is at or before your read position in the\nconversation, or when you wrote it. The app's unread badge counts by the same rule.",[15,749,750,751,753],{},"Listing never marks anything read. To mark a conversation read, send the ",[54,752,432],{}," of\na message:",[136,755,758],{"className":138,"code":756,"filename":757,"language":141,"meta":142,"style":142},"curl -X POST 'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fread' \\\n  -H 'X-Cargoplot-Key: \u003Ctoken>' \\\n  -H 'Content-Type: application\u002Fjson' \\\n  -d '{\"message\": \"d0qhk3bb1d1m1c7ehqkg\"}'\n","POST \u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fread",[54,759,760,775,784,793],{"__ignoreMap":142},[146,761,762,764,767,770,773],{"class":148,"line":149},[146,763,153],{"class":152},[146,765,766],{"class":156}," -X",[146,768,769],{"class":160}," POST",[146,771,772],{"class":160}," 'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fread'",[146,774,164],{"class":156},[146,776,777,780,782],{"class":148,"line":167},[146,778,779],{"class":156},"  -H",[146,781,161],{"class":160},[146,783,164],{"class":156},[146,785,786,788,791],{"class":148,"line":194},[146,787,779],{"class":156},[146,789,790],{"class":160}," 'Content-Type: application\u002Fjson'",[146,792,164],{"class":156},[146,794,795,798],{"class":148,"line":200},[146,796,797],{"class":156},"  -d",[146,799,800],{"class":160}," '{\"message\": \"d0qhk3bb1d1m1c7ehqkg\"}'\n",[15,802,803,804,807,808,811],{},"That marks the message ",[124,805,806],{},"and every earlier one"," of the conversation as read, and\nanswers ",[54,809,810],{},"204"," with no body. Send the newest message you have shown. Marking an\nolder message than the last one you marked changes nothing, so the call can be\nrepeated; a message cannot be marked unread.",[15,813,814,815,818,819,822],{},"Your position and your organization's both move, as when you read the conversation in the app.\nYour unread badge clears and a colleague's does not. What Cargoplot's service team has read does\nnot change. A\n",[54,816,817],{},"message"," that does not exist, or that belongs to another conversation, answers\n",[54,820,821],{},"400"," and names the field.",[19,824,826],{"id":825},"posting-a-message","Posting a message",[136,828,831],{"className":138,"code":829,"filename":830,"language":141,"meta":142,"style":142},"curl -X POST 'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage' \\\n  -H 'X-Cargoplot-Key: \u003Ctoken>' \\\n  -H 'Content-Type: application\u002Fjson' \\\n  -d '{\"text\": \"Could you confirm the pickup date?\"}'\n","POST \u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage",[54,832,833,846,854,862],{"__ignoreMap":142},[146,834,835,837,839,841,844],{"class":148,"line":149},[146,836,153],{"class":152},[146,838,766],{"class":156},[146,840,769],{"class":160},[146,842,843],{"class":160}," 'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment\u002FC2AE-XEE1\u002Fchat\u002Fmessage'",[146,845,164],{"class":156},[146,847,848,850,852],{"class":148,"line":167},[146,849,779],{"class":156},[146,851,161],{"class":160},[146,853,164],{"class":156},[146,855,856,858,860],{"class":148,"line":194},[146,857,779],{"class":156},[146,859,790],{"class":160},[146,861,164],{"class":156},[146,863,864,866],{"class":148,"line":200},[146,865,797],{"class":156},[146,867,868],{"class":160}," '{\"text\": \"Could you confirm the pickup date?\"}'\n",[15,870,871],{},"The message is written as the user your token belongs to, in the conversation\nof the path, and the people who are notified of a message written in the app are\nnotified of this one: for a chat message Cargoplot's service team, for a customs\nmessage the shipment's customs agent, by email. It appears in the app at once.",[15,873,874],{},"The body has one key:",[24,876,877,886],{},[27,878,879],{},[30,880,881,884],{},[33,882,883],{},"Key",[33,885],{},[43,887,888],{},[30,889,890,894],{},[48,891,892],{},[54,893,469],{},[48,895,896,897,900],{},"Required. Plain text, at most 10,000 characters, and not only whitespace. It is kept as written: ",[54,898,899],{},"\u003Cb>"," is text here, not formatting.",[15,902,903,904,906,907,909],{},"Any other key answers ",[54,905,821],{},", and ",[54,908,817],{}," names it. The conversation comes from\nthe path, never from the body.",[15,911,912,913,916,917,920],{},"The answer is ",[54,914,915],{},"201"," with the message, in the shape of the list. ",[124,918,919],{},"Keep it",": a\nmessage reaches the list a moment after it is posted, so a list right after a\npost may not show it yet.",[15,922,923],{},"Messages are posted as text: files cannot be sent through the API.",[555,925,927],{"id":926},"replying-in-the-customs-conversation","Replying in the customs conversation",[15,929,930,931,934,935,681],{},"A message to the customs agent is a ",[389,932,933],{},"reply",". It is accepted once the shipment has\na customs agent and its customs conversation holds a message, which is when the\nconversation appears in the app. Before that, and on a shipment without a customs\nagent, it answers ",[54,936,937],{},"409",[136,939,941],{"className":173,"code":940,"language":175,"meta":142,"style":142},"{\n  \"code\": 10,\n  \"message\": \"there is no customs conversation to reply in: the shipment has no customs agent, or its customs conversation holds no message yet\",\n  \"details\": []\n}\n",[54,942,943,947,959,971,978],{"__ignoreMap":142},[146,944,945],{"class":148,"line":149},[146,946,183],{"class":182},[146,948,949,952,954,957],{"class":148,"line":167},[146,950,951],{"class":156},"  \"code\"",[146,953,206],{"class":182},[146,955,956],{"class":156},"10",[146,958,212],{"class":182},[146,960,961,964,966,969],{"class":148,"line":194},[146,962,963],{"class":156},"  \"message\"",[146,965,206],{"class":182},[146,967,968],{"class":160},"\"there is no customs conversation to reply in: the shipment has no customs agent, or its customs conversation holds no message yet\"",[146,970,212],{"class":182},[146,972,973,976],{"class":148,"line":200},[146,974,975],{"class":156},"  \"details\"",[146,977,343],{"class":182},[146,979,980],{"class":148,"line":215},[146,981,380],{"class":182},[15,983,984],{},"A client cannot start a customs conversation through the API.",[555,986,988],{"id":987},"sending-the-same-message-again","Sending the same message again",[15,990,991,992,998,999,1002],{},"Without an ",[402,993,995],{"href":994},"\u002Ferrors#idempotency-keys",[54,996,997],{},"Idempotency-Key"," nothing is de-duplicated:\nthe same text sent twice can be meant twice, and is posted twice. Send a key to\nmake a retry safe. The same key and the same request answer the first message,\nwith ",[54,1000,1001],{},"Idempotent-Replayed: true"," among the response headers, and post nothing.",[15,1004,1005,1006,102],{},"A post and a read mark are writes, so they spend the ",[402,1007,1009],{"href":1008},"\u002Frate-limits","write allowance",[19,1011,1013],{"id":1012},"what-is-not-here","What is not here",[1015,1016,1017,1024,1033],"ul",{},[1018,1019,1020,1023],"li",{},[124,1021,1022],{},"Downloading and sending attachments."," A message lists its files by name and\nmedia type; the app is where they are opened.",[1018,1025,1026,906,1029,1032],{},[124,1027,1028],{},"Editing and deleting a message",[124,1030,1031],{},"mentions",", which belong to notes. These stay in the app.",[1018,1034,1035,1038,1039,297,1042,1045,1046,1049],{},[124,1036,1037],{},"The conversation itself",", with an unread count and whether it is open or\nclosed. The paths ",[54,1040,1041],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fchat",[54,1043,1044],{},"\u002Fv1\u002Finquiry\u002F{inquiry}\u002Fchat"," and\n",[54,1047,1048],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fcustoms"," are kept for it.",[19,1051,1053],{"id":1052},"refusals","Refusals",[24,1055,1056,1066],{},[27,1057,1058],{},[30,1059,1060,1063],{},[33,1061,1062],{},"Status",[33,1064,1065],{},"When",[43,1067,1068,1090,1099,1111],{},[30,1069,1070,1074],{},[48,1071,1072],{},[54,1073,821],{},[48,1075,1076,1077,1080,1081,1083,1084,1086,1087,1089],{},"A query parameter, a cursor or a ",[54,1078,1079],{},"filter"," that is refused, as on every ",[402,1082,405],{"href":404},"; a ",[54,1085,469],{}," that is missing, empty, only whitespace or over the limit; a ",[54,1088,817],{}," that is not a message of this conversation; a key the endpoint does not know.",[30,1091,1092,1096],{},[48,1093,1094],{},[54,1095,119],{},[48,1097,1098],{},"No such shipment or inquiry in your organization. Another organization's and one that does not exist answer the same.",[30,1100,1101,1105],{},[48,1102,1103],{},[54,1104,937],{},[48,1106,1107,1108,1110],{},"A reply in a customs conversation that does not exist yet, or a request with the same ",[54,1109,997],{}," that is still being processed.",[30,1112,1113,1118],{},[48,1114,1115],{},[54,1116,1117],{},"429",[48,1119,1120,1121,102],{},"The write allowance is used up. See ",[402,1122,1123],{"href":1008},"rate limits",[19,1125,1127],{"id":1126},"from-an-ai-assistant","From an AI assistant",[15,1129,1130,1131,1135],{},"An ",[402,1132,1134],{"href":1133},"\u002Fai-assistants","AI assistant"," reads the conversations and, when you have let it\nmake changes, posts and marks them read. What it reads is text written by people,\nby email too: it treats the text as quoted, never as an instruction.",[1137,1138,1139],"style",{},"html pre.shiki code .sFR8T, html code.shiki .sFR8T{--shiki-default:#B392F0;--shiki-dark:#B392F0}html pre.shiki code .s8ozJ, html code.shiki .s8ozJ{--shiki-default:#79B8FF;--shiki-dark:#79B8FF}html pre.shiki code .s4wv1, html code.shiki .s4wv1{--shiki-default:#9ECBFF;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .suv1-, html code.shiki .suv1-{--shiki-default:#E1E4E8;--shiki-dark:#E1E4E8}",{"title":142,"searchDepth":167,"depth":167,"links":1141},[1142,1143,1147,1148,1149,1153,1154,1155],{"id":21,"depth":167,"text":22},{"id":133,"depth":167,"text":134,"children":1144},[1145,1146],{"id":505,"depth":194,"text":557},{"id":543,"depth":194,"text":668},{"id":674,"depth":167,"text":675},{"id":739,"depth":167,"text":740},{"id":825,"depth":167,"text":826,"children":1150},[1151,1152],{"id":926,"depth":194,"text":927},{"id":987,"depth":194,"text":988},{"id":1012,"depth":167,"text":1013},{"id":1052,"depth":167,"text":1053},{"id":1126,"depth":167,"text":1127},"Read the chat and the customs conversation of a shipment and the chat of an inquiry, post into them as the authenticated user, and mark them read.","md","working","mdi-message-text-outline",{},true,5.7,"\u002Fmessages",{"title":6,"description":1156},{"loc":1163,"lastmod":1166},"2026-11-08","CbhYsI6LZJdX0B3msnu_Kq9ZNugY092rKAvwzDtvyVk",[1169,1174,1178,1182,1187,1192,1197,1202,1203,1207,1210,1213,1217,1221],{"path":1170,"title":1171,"navTitle":1171,"icon":1172,"group":1173,"order":149},"\u002F","Overview","mdi-book-open-page-variant-outline","getting-started",{"path":1175,"title":1176,"navTitle":3,"icon":1177,"group":1173,"order":167},"\u002Fauthentication","Authentication","mdi-key-variant",{"path":1133,"title":1179,"navTitle":1180,"icon":1181,"group":1173,"order":194},"Connect an AI assistant","AI assistants","mdi-robot-outline",{"path":1183,"title":1184,"navTitle":1185,"icon":1186,"group":1158,"order":200},"\u002Finquiries","Creating and updating inquiries","Inquiries","mdi-file-document-edit-outline",{"path":1188,"title":1189,"navTitle":1189,"icon":1190,"group":1158,"order":1191},"\u002Fquotes","Quotes","mdi-tag-multiple-outline",4.5,{"path":1193,"title":1194,"navTitle":1195,"icon":1196,"group":1158,"order":215},"\u002Fshipments","Changing a shipment","Shipments","mdi-truck-check-outline",{"path":1198,"title":1199,"navTitle":1199,"icon":1200,"group":1158,"order":1201},"\u002Fdocuments","Documents","mdi-file-upload-outline",5.5,{"path":1163,"title":6,"navTitle":6,"icon":1159,"group":1158,"order":1162},{"path":1204,"title":1205,"navTitle":3,"icon":1206,"group":1158,"order":228},"\u002Ftracking","Shipment tracking","mdi-map-marker-path",{"path":1008,"title":1208,"navTitle":3,"icon":1209,"group":1158,"order":241},"Rate limits","mdi-speedometer",{"path":404,"title":1211,"navTitle":3,"icon":1212,"group":1158,"order":254},"Pagination and filtering","mdi-filter-variant",{"path":1214,"title":1215,"navTitle":3,"icon":1216,"group":1158,"order":267},"\u002Ferrors","Errors","mdi-alert-outline",{"path":1218,"title":1219,"navTitle":3,"icon":1220,"group":1158,"order":280},"\u002Fglossary","Glossary","mdi-book-alphabet",{"path":1222,"title":1223,"navTitle":3,"icon":1224,"group":1225,"order":311},"\u002Fversioning","Versioning","mdi-tag-outline","current",1794912850101]