Verb routes: update, delete

Reference for Verb, one group of Verb routes.

Verb.update

Changes the given properties of a Verb. Verb page.

Text

PATCH /{namespace}/verbs/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Verb.
`name`	`string`		The camelCase action form.
`event`	`string`		The event the Verb emits.
`publishedIn`	Version		The first published Version that serves it; from then on, edits go through a Change and `delete` refuses.

Returns

Output	Type	Required	Description
`verb`	Verb	required	The Verb.

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/verbs/verb_hlkWBvrAyZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "verb": {
    "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
    "$type": "Verb",
    "name": "Leaseline",
    "event": "Example event",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Verb.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Verb.delete

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