Skip to content

Thread

A Thread is a set of Messages replying to one another inside a Channel.

Properties

PropertyTypeRequiredDescription
subjectstringWhat the Thread is about.

Object

JSON
{
  "$id": "https://api.sb/kilnbakery.com/threads/thread_1",
  "$type": "Thread",
  "subject": "Example subject"
}

Relationships

  • A Thread groups many Messages: a Thread groups Messages that reply to one another. groups, inverse thread.
  • A Thread is hosted in one Channel: a Channel holds Threads. hostedIn, inverse hosts.
  • A Thread has many Questions: each Question posts in the Thread of the record it concerns, where free-text replies land. questions, inverse postedIn.
  • A Thread is raised in one Conversation: the intake Threads a support Conversation opens, each deadline counted from the Conversation’s first Message. raisedIn, inverse raises.

Verbs

  1. createCreates a Thread.
    POST /{namespace}/threadsdoThread.created
  2. getReturns one Thread by id.
    GET /{namespace}/threads/{id}readNo Event
  3. listReturns Threads, newest first, one page at a time.
    GET /{namespace}/threadsreadNo Event
  4. updateChanges the given properties of a Thread.
    PATCH /{namespace}/threads/{id}doThread.updated
  5. deleteDeletes a Thread; its history is kept.
    DELETE /{namespace}/threads/{id}doThread.deleted

Permissions

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

Operationowneradminmemberviewer
Thread.createYesYesYesNo
Thread.getYesYesYesYes
Thread.listYesYesYesYes
Thread.updateYesYesYesNo
Thread.deleteYesYesYesNo

Call it

Text
Add a thread to PetPantry.

Example

A parent's question about a missed session, the tutor's reply, and the parent's follow-up form one Thread in the help@ Channel.