Keyword routes: update, delete

Reference for Keyword, one group of Keyword routes.

Keyword.update

Changes the given properties of a Keyword. Verb page.

Text

PATCH /{namespace}/keywords/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Keyword.
`phrase`	`string`		The words searched or asked.
`form`	`string`		One of `search` or `question`.

Returns

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use 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/keywords/keyword_cEoeFM4Drs \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"form":"search"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "keyword": {
    "$id": "https://api.sb/leaseline.app/keywords/keyword_cEoeFM4Drs",
    "$type": "Keyword",
    "phrase": "Example phrase",
    "form": "search"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Keyword.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Keyword.delete

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