Skip to content

by Startups.Studio

Product Build and ship Flag

Flag.update

PATCH /{namespace}/flags/{id}

Changes the given properties of a Flag.

Noun: Flag
Mode: do
Event: Flag.updated

You, to your agent

Change the latest flag.

curl -X PATCH https://api.sb/ledgerlark.com/flags/flag_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"new-checkout"}'

import { $ } from 'startup-builder'

const flag = await $.Flag.update({ id: 'flag_1', key: 'new-checkout' })

npx startup-builder do Flag.update --json '{"id":"flag_1","key":"new-checkout"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flag.update({ id: 'flag_1', key: 'new-checkout' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Flag.
`key`	`string`		The name code reads.
`rules`	`json`		Who gets which value, including percentage splits.

Outputs

Output	Type	Required	Description
`flag`	Flag	required	The Flag.

Effects

Emits Flag.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.	Flag.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`.

Flag.list

Previous Page

Implementation

Next Page