ICP methods: update, delete
The ICP Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for ICP, one group of ICP methods.
ICP.update
Changes the given properties of an ICP. Verb page.
interface ICPVerbs {
update(input: ICPUpdateInput, options?: SB.CallOptions): SB.Call<ICP>
}Emits ICP.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the ICP. |
description | text | Who they are and what they do. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
icp | ICP | required | The ICP. |
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
import { $ } from 'startup-builder'
const icp = await $.ICP.update({ id: 'icp_EwhsJU4AOW', description: 'Renewal tracking for up to 200 units.' })ICP.delete
Deletes an ICP: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface ICPVerbs {
delete(input: ICPDeleteInput, options?: SB.CallOptions): SB.Call<ICP>
}Emits ICP.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the ICP. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
icp | ICP | required | The ICP. |
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
import { $ } from 'startup-builder'
const icp = await $.ICP.delete({ id: 'icp_EwhsJU4AOW' })