Replace optin

Sets the signed-in caller's OWN opt-in to public betas: on, every public beta and each one promoted later is on for them; off, none is.

PUT /v1/flag/optin

Addresshttps://api.hanzo.ai/v1/flag/optin
MethodPUT
Operationput_flag_optin
AuthAuthorization: Bearer $HANZO_API_KEY

Sets the signed-in caller's OWN opt-in to public betas: on, every public beta and each one promoted later is on for them; off, none is. Self only: the row written is the caller's validated subject, whatever the request says. Opting in while the org they act in blocked it is refused; opting out never is.

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
onbodyboolean—On opts the caller in to every public beta, current and future, when true, and out when false.

Response

StatusBodyMeaning
200flag.optinOutok
defaultproblem-detailsrefused

200 body — 3 fields.

FieldInTypeAlwaysDescription
blockedbodyboolean—Blocked is true when the org the caller acts in turned the opt-in off for its members.
onbodyboolean—On is true when the caller opted in: every public beta, and each one promoted later, is on for them unless Blocked.
publicbodystring[]—Public is the id of every beta anyone may opt in to (beta.<id>).

Failure carries the platform error shape — see Errors.

Examples

hanzo flag optin replace
import { Configuration, FlagApi } from 'hanzoai';

const api = new FlagApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putFlagOptin({ on: false });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FlagApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FlagApi(client).put_flag_optin(on=False)
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FlagAPI.PutFlagOptin(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, flag_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = flag_api::put_flag_optin(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FlagApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FlagApi(client).putFlagOptin();
curl -X PUT https://api.hanzo.ai/v1/flag/optin \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "on": false
     }'

MCP reaches flag through the flag tool, which names its 12 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_flag_activity"
         }
       }
     }'

Flag API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.