Component routes: update, delete

Reference for Component, one group of Component routes.

Component.update

Changes the given properties of a Component. Verb page.

Text

PATCH /{namespace}/components/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Component.
`name`	`string`		The name a Template places it by, such as `Pricing`.
`props`	`json`		The schema of the props it accepts.
`region`	`string`		Where it sits: `header`, `section`, `footer`, or `notice`.
`interactive`	`boolean`		True when it runs code in the browser; it still renders a static still without it.

Returns

Output	Type	Required	Description
`component`	Component	required	The Component.

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "component": {
    "$id": "https://api.sb/leaseline.app/components/component_1qALyfTlfx",
    "$type": "Component",
    "name": "Leaseline",
    "props": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Component.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Component.delete

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