Skip to content

Thread routes: update, delete

The Thread Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Thread, one group of Thread routes.

Thread.update

Changes the given properties of a Thread. Verb page.

Text
PATCH /{namespace}/threads/{id}

Path: id. Body, as JSON: the other inputs. Emits Thread.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Thread.
subjectstringWhat the Thread is about.

Returns

OutputTypeRequiredDescription
threadThreadrequiredThe Thread.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/threads/thread_GzIHRhK100 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"Example subject"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "thread": {
    "$id": "https://api.sb/leaseline.app/threads/thread_GzIHRhK100",
    "$type": "Thread",
    "subject": "Example subject"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Thread.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Thread.delete

Deletes a Thread: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/threads/{id}

Path: id. Emits Thread.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Thread.

Returns

OutputTypeRequiredDescription
threadThreadrequiredThe Thread.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/threads/thread_GzIHRhK100 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "thread": {
    "$id": "https://api.sb/leaseline.app/threads/thread_GzIHRhK100",
    "$type": "Thread",
    "subject": "Example subject"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Thread.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}