Update stakeholders

Changes one of the caller org's stakeholders.

PATCH /v1/captable/stakeholders/{id}

Captable → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/captable/stakeholders/{id}`
Method	`PATCH`
Operation	`patch_captable_stakeholders_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Changes one of the caller org's stakeholders. It is a PARTIAL update: only the fields the request names are written, and a field sent as null clears that column. A request that names no updatable field is refused, and an id this org does not hold is not found.

The values are stored as sent. Unlike adding a stakeholder, this route does not check the email's shape or the type and relationship vocabularies, so it can record a value that adding one would have rejected.

Request

12 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the stakeholder to update.
`city`	body	any	—	City is the stakeholder's city.
`currentRelationship`	body	any	—	CurrentRelationship is how the stakeholder relates to the company, e.g. FOUNDER, INVESTOR or EMPLOYEE.
`email`	body	any	—	Email is the stakeholder's email.
`id`	body	string	—	ID is the stakeholder to update.
`institutionName`	body	any	—	InstitutionName names the institution, when the stakeholder is one.
`name`	body	any	—	Name is the stakeholder's full name.
`stakeholderType`	body	any	—	StakeholderType is INDIVIDUAL or INSTITUTION.
`state`	body	any	—	State is the stakeholder's state or province.
`streetAddress`	body	any	—	StreetAddress is the stakeholder's street address.
`taxId`	body	any	—	TaxID is the stakeholder's tax identifier.
`zipcode`	body	any	—	Zipcode is the stakeholder's postal code.

Response

Status	Body	Meaning
`200`	captable.captableUpdated	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`message`	body	string	—	Message is the human sentence the cap table wrote, e.g. "Company updated".
`success`	body	boolean	—	Success is true when the update was applied.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo captable stakeholders update <id>

.ts

.py

.go

.rs

.java

import { Configuration, CaptableApi } from 'hanzoai';

const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchCaptableStakeholdersById({ id: 'id', city: "<city>", currentRelationship: "<currentRelationship>" });

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).patch_captable_stakeholders_by_id(id='id', city="<city>", current_relationship="<currentRelationship>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CaptableAPI.PatchCaptableStakeholdersById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::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::patch_captable_stakeholders_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CaptableApi;

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

var result = new CaptableApi(client).patchCaptableStakeholdersById();

curl -X PATCH https://api.hanzo.ai/v1/captable/stakeholders/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "city": "<city>",
       "currentRelationship": "<currentRelationship>"
     }'

MCP reaches captable through the captable tool, which names its 30 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": "list_captable_classes"
         }
       }
     }'

Captable API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousUpdate classes NextCreate classes