/v1/notes/{id}

PUT

/v1/notes/{id}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

text/plain

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.dev.ordermesh.io/v1/notes/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": "Customer address issue has been resolved. The merchant provided a corrected address and order processing has resumed",
    "isPrivate": null
}'

Response Example

200 - Success Example

{
    "id": null,
    "content": "Customer address issue has been resolved. The merchant provided a corrected address and order processing has resumed",
    "isPrivate": false,
    "resourceReference": {
        "entityType": "Order",
        "entityId": "6686def3cb6eb9b3d1740f96",
        "merchantId": "6e0a8bd9-93b1-4f60-9af0-ea9cd5c4756a",
        "vendorId": "33ba401a-28fd-4129-b335-5cd7b81c45af"
    },
    "createdBy": {
        "userId": "3404b73a-8e39-4de5-9cba-081e251564a2",
        "userName": "Agent 1"
    },
    "createdAt": "2026-03-05T14:17:58.3194231Z",
    "updatedAt": "2026-03-06T14:17:58.3194235Z"
}

Modified at 2026-03-06 14:23:17

/v1/notes/{noteId}

/v1/notes/{id}