API referenceFormulas

Promote, park or retire a brand-mark formula

Move a formula between held, active and disabled.

Move a formula between held, active and disabled. Promotion re-lints the stored spec, because active is the moment it starts reaching renders and a row may have been written under an older contract. A disabled formula leaves existing projects rendering a static mark.

The bug slot only: a caption formula has no held/active machine, because publishing to the shared catalog is moderated.

PATCH
/formulas/{slug}

Authorization

bearerAuth
AuthorizationBearer <token>

Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….

In: header

Path Parameters

slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/formulas/string" \  -H "Content-Type: application/json" \  -d '{    "status": "held"  }'
{
  "data": {
    "slot": "bug",
    "slug": "string",
    "title": "string",
    "hint": "string",
    "spec": {
      "property1": null,
      "property2": null
    },
    "status": "held",
    "tiers": [
      "string"
    ],
    "built_in": true,
    "emitted": {
      "property1": 0,
      "property2": 0
    }
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}