arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/submit_note

Create Note

Adds a note an order's log. Notes are for back reference purposes only and are NOT used for outside communication instructions to the production department or customer service.

Body

Name Description Type Additional information
order_id Assigned FinerWorks order id number number

Required

subject subject line of message text

Required

Max length: 100

message Body of message text

Required

Example JSON Body

application/json, text/json

{
  "order_id": 123456,
  "subject": "Note to self",
  "message": "This was my very first sale."
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/submit_note' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "order_id": 123456,
  "subject": "Note to self",
  "message": "This was my very first sale."
}'