Comment

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/shiftnote.app/comments/comment_1",
  "$type": "Comment",
  "body": "Example body"
}

RelationshipsCopy Anchor Link

• A Comment annotates one Thing: a Comment is an internal note on one Thing, never sent to a Contact. annotates, inverse comments.
• A Comment’s author is one Worker: every Comment names the Worker, human or agent, who wrote it. author, inverse writes.

VerbsCopy Anchor Link

1. createCreates a Comment.
   POST /{namespace}/commentsdoComment.created
2. getReturns one Comment by id.
   GET /{namespace}/comments/{id}readNo Event
3. listReturns Comments, newest first, one page at a time.
   GET /{namespace}/commentsreadNo Event
4. updateChanges the given properties of a Comment.
   PATCH /{namespace}/comments/{id}doComment.updated
5. deleteDeletes a Comment; its history is kept.
   DELETE /{namespace}/comments/{id}doComment.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add a comment to RouteWise.

ExampleCopy Anchor Link

A support Agent leaves a Comment on a Conversation: refund approved, send confirmation. The Contact never sees it.