STstuut
sales-order-cases

Add a Note to a Sales Order Case

Add a Note to a Sales Order Case

post/v2/sales-order-cases/{case_id}/notes

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

case_idstring required

Request body

textstring required

Response

Successful Response

created_atstring date-time required
modified_atstring date-time required
idstring required
case_idstring required
type'case_created' | 'case_updated' | 'case_resolved' | 'attention_requested' | 'email_sent' | 'email_replied' | 'call_completed' | 'call_scheduled' | 'sales_order_updated' | 'outreach_paused' | 'outreach_resumed' | 'note_added' required
actor'system' | 'customer' | 'user' required
occurred_atstring date-time required
payloadobject required

Type-specific details. Links to other records use the foreign-key columns.

summarystring nullable required

Review-written summary of the interaction, scrubbed of sensitive details.

review_status'pending' | 'completed' | 'failed' required

Progress of the interaction review that fills in an event's summary and payload.

call_idstring nullable required

The call, fetched through the calls endpoints.

email_idstring nullable required

The email, fetched through the emails endpoints.

user_idstring nullable required

The user who acted, for USER events.

user_namestring nullable required

The acting user's full name, for USER events.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.