Create Note

Create a new note record for annotations or comments

This endpoint requires authentication with notes:write permission.

Request Parameters

title · string · required

The title or subject of the note

body · string · required

The main content or body of the note

created_by · string

ID or name of the user creating the note (auto-filled if not provided)

associated_id · string

Optional ID of the resource this note is associated with (e.g., order ID)

Response

id · string

Unique identifier for the created note

title · string

The title of the note

body · string

The content of the note

created_date · string

Timestamp when the note was created

last_modified_date · string

Timestamp when the note was last updated

created_by · string

User who created the note

last_modified_by · string

User who last modified the note

Request Example

cURL

curl --location --request POST 'https://api.stateset.com/v1/notes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "title": "Important Update",
    "body": "Customer requested expedited shipping",
    "associated_id": "order_123"
}'

Response Example

Success Response

{
  "id": "note_001",
  "title": "Important Update",
  "body": "Customer requested expedited shipping",
  "created_date": "2024-01-01T12:00:00Z",
  "last_modified_date": "2024-01-01T12:00:00Z",
  "created_by": "user_123",
  "last_modified_by": "user_123"
}