Hanzo
OpenapiCaptable

Changes one of the caller org's stakeholders.

Changes one of the caller org's stakeholders.

PATCH /v1/captable/stakeholders/{id}

Addresshttps://api.hanzo.ai/v1/captable/stakeholders/{id}
MethodPATCH
Operationpatch_captable_stakeholders_by_id
AuthAuthorization: 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).

FieldInTypeRequiredDescription
idpathstringyesID is the stakeholder to update. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal,…
citybodyanyCity is the stakeholder's city.
currentRelationshipbodyanyCurrentRelationship is how the stakeholder relates to the company, e.g. FOUNDER, INVESTOR or EMPLOYEE.
emailbodyanyEmail is the stakeholder's email.
idbodystringID is the stakeholder to update. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal,…
institutionNamebodyanyInstitutionName names the institution, when the stakeholder is one.
namebodyanyName is the stakeholder's full name.
stakeholderTypebodyanyStakeholderType is INDIVIDUAL or INSTITUTION.
statebodyanyState is the stakeholder's state or province.
streetAddressbodyanyStreetAddress is the stakeholder's street address.
taxIdbodyanyTaxID is the stakeholder's tax identifier.
zipcodebodyanyZipcode is the stakeholder's postal code.

Response

StatusBodyMeaning
200captableUpdatedok

200 body — 2 fields.

FieldInTypeAlwaysDescription
messagebodystringMessage is the human sentence the cap table wrote, e.g.
successbodybooleanSuccess is true when the update was applied.

Failure carries the platform error shape — see Errors.

Examples

hanzo captable stakeholders update <id>

Captable API · All Hanzo APIs · Interactive reference

How is this guide?

On this page