Purpose programs: update, delete

Reference for Purpose, one group of Purpose programs.

Purpose.update

Changes the given properties of a Purpose. Verb page.

Text

do: return await $.Purpose.update(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Purpose.update({ id: 'purpose_Aoz9nBatRR', name: 'Leaseline' })"
  }
}

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