Skip to content

by Startups.Studio

Variant.update

PATCH /{namespace}/variants/{id}

Changes the given properties of a Variant.

Noun: Variant
Mode: do
Event: Variant.updated

You, to your agent

Change the latest variant.

curl -X PATCH https://api.sb/kilnbakery.com/variants/variant_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":{}}'

import { $ } from 'startup-builder'

const variant = await $.Variant.update({ id: 'variant_1', value: {} })

npx startup-builder do Variant.update --json '{"id":"variant_1","value":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Variant.update({ id: 'variant_1', value: {} })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Variant.
`key`	`string`		The name the Flag returns for it.
`value`	`json`		What it changes: copy, behavior, a definition Version, or a Thing.
`control`	`boolean`		True for the current definition every challenger is judged against.
`follows`	Variant		The Variant it was drafted from by a learn step.

Outputs

Output	Type	Required	Description
`variant`	Variant	required	The Variant.

Effects

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

Variant.list

Previous Page

Video

Next Page