Hanzo
OpenapiCrm

Replaces one of the caller org's companies.

Replaces one of the caller org's companies.

PUT /v1/crm/companies/{id}

Addresshttps://api.hanzo.ai/v1/crm/companies/{id}
MethodPUT
Operationput_crm_companies_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Replaces one of the caller org's companies. Every writable field is taken from the request, so a field the request omits is CLEARED — send the whole record. A name is required.

Request

12 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID names the company to update and comes from the path.
arrbodyintegerARR is annual recurring revenue in minor units (cents) of Currency.
citybodystringCity is the head-office city.
countrybodystringCountry is the head-office country.
currencybodystringCurrency is the ISO code ARR is denominated in; empty defaults to USD.
domainNamebodystringDomainName is the company's primary domain, e.g.
employeesbodyintegerEmployees is the headcount.
idbodystringID names the company to update and comes from the path.
idealCustomerProfilebodybooleanICP marks the company as an ideal-customer-profile fit.
linkedinLinkbodystringLinkedin is the company's LinkedIn URL.
namebodystringName is the company name.
xLinkbodystringXLink is the company's X (Twitter) URL.

Response

StatusBodyMeaning
200Companyok

200 body — 13 fields.

FieldInTypeAlwaysDescription
arrbodyintegerARR is annual recurring revenue in minor units (cents) of Currency.
citybodystringCity is the head-office city.
countrybodystringCountry is the head-office country.
createdAtbodyintegerCreatedAt is the unix second the company was created.
currencybodystringCurrency is the ISO code ARR is denominated in; a write that names none stores USD.
domainNamebodystringDomainName is the company's primary domain, e.g.
employeesbodyintegerEmployees is the headcount.
idbodystringID is the server-minted company id ("comp_" + 128 random bits).
idealCustomerProfilebodybooleanICP marks the company as an ideal-customer-profile fit.
linkedinLinkbodystringLinkedin is the company's LinkedIn URL.
namebodystringName is the company name.
updatedAtbodyintegerUpdatedAt is the unix second of the last write.
xLinkbodystringXLink is the company's X (Twitter) URL.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm companies set <id>

CRM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page