OpenapiCaptable
Sets the caller org's company name and incorporation details.
Sets the caller org's company name and incorporation details.
PUT /v1/captable/company
| Address | https://api.hanzo.ai/v1/captable/company |
| Method | PUT |
| Operation | put_captable_company |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sets the caller org's company name and incorporation details. The name is required; the three incorporation fields are optional and each is stored as empty when omitted, so a call that sends only a name CLEARS them. The company row itself is seeded when the tenant's store first opens, so this never creates one.
Request
4 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
incorporationCountry | body | any | — | IncorporationCountry is the ISO country the entity is incorporated in. Optional; omitted, null or empty clears it. |
incorporationState | body | any | — | IncorporationState is the state or province of incorporation. |
incorporationType | body | any | — | IncorporationType is the entity kind, e.g. |
name | body | any | — | Name is the company's legal name. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | captableUpdated | ok |
200 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
message | body | string | — | Message is the human sentence the cap table wrote, e.g. |
success | body | boolean | — | Success is true when the update was applied. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable company replaceimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putCaptableCompany({ incorporationCountry: "<incorporationCountry>", incorporationState: "<incorporationState>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CaptableApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CaptableApi(client).put_captable_company(incorporation_country="<incorporationCountry>", incorporation_state="<incorporationState>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.PutCaptableCompany(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, captable_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = captable_api::put_captable_company(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CaptableApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CaptableApi(client).putCaptableCompany();curl -X PUT https://api.hanzo.ai/v1/captable/company \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"incorporationCountry": "<incorporationCountry>",
"incorporationState": "<incorporationState>"
}'The door reaches captable through the captable tool, which names its 31 operations with its own verbs — this one among them, under a name only the door 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": "list_captable_classes"
}
}
}'How is this guide?