Skip to content

by Startups.Studio

Finance Entitlement

Entitlement.update

PATCH /{namespace}/entitlements/{id}

Changes the given properties of an Entitlement.

Noun: Entitlement
Mode: do
Event: Entitlement.updated

You, to your agent

Change the latest entitlement.

curl -X PATCH https://api.sb/tutorloop.com/entitlements/entitlement_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"verb_1"}'

import { $ } from 'startup-builder'

const entitlement = await $.Entitlement.update({ id: 'entitlement_1', verb: 'verb_1' })

npx startup-builder do Entitlement.update --json '{"id":"entitlement_1","verb":"verb_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Entitlement.update({ id: 'entitlement_1', verb: 'verb_1' })"
  }
}

Update changes the given properties of an Entitlement. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Entitlement.
`verb`	Verb		The Verb it grants.
`limit`	Limit		The Limit that bounds it.
`kind`	`string`		Computed, never set: `feature`, or `limit` when a Limit bounds it.

Outputs

Output	Type	Required	Description
`entitlement`	Entitlement	required	The Entitlement.

Effects

Emits Entitlement.updated.
Two-way: try, send, do.

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.	Entitlement.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Entitlement.list

Previous Page

Forecast

Next Page