Portfolio routes: update, delete

Reference for Portfolio, one group of Portfolio routes.

Portfolio.update

Changes the given properties of a Portfolio. Verb page.

Text

PATCH /{namespace}/portfolios/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Portfolio.
`type`	list of Noun		The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`		The saved query that defines a dynamic Collection.
`membership`	`string`		How each member belongs: `held`, `owned`, `contracted`, or `made`.

Returns

Output	Type	Required	Description
`portfolio`	Portfolio	required	The Portfolio.

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/portfolios/portfolio_zkvUnP8LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"membership":"held"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "portfolio": {
    "$id": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY",
    "$type": "Portfolio",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ],
    "membership": "held"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Portfolio.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Portfolio.delete

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