Goal routes: update, delete

Reference for Goal, one group of Goal routes.

Goal.update

Changes the given properties of a Goal. Verb page.

Text

PATCH /{namespace}/goals/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Goal.
`objective`	`text`		The qualitative outcome.
`horizon`	`string`		One of `day`, `week`, `quarter`, `year`, or `three-years`.

Returns

Output	Type	Required	Description
`goal`	Goal	required	The Goal.

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/goals/goal_L9PBQQhfuF \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"horizon":"day"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "goal": {
    "$id": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
    "$type": "Goal",
    "objective": "Example objective",
    "horizon": "day"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Goal.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Goal.delete

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