Purpose routes: update, delete

Reference for Purpose, one group of Purpose routes.

Purpose.update

Changes the given properties of a Purpose. Verb page.

Text

PATCH /{namespace}/purposes/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Purpose.
`name`	`string`		The reason, such as marketing email or call recording.

Returns

Output	Type	Required	Description
`purpose`	Purpose	required	The Purpose.

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "purpose": {
    "$id": "https://api.sb/leaseline.app/purposes/purpose_Aoz9nBatRR",
    "$type": "Purpose",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Purpose.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Purpose.delete

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