OpenapiCrm
Replaces one of the caller org's companies.
Replaces one of the caller org's companies.
PUT /v1/crm/companies/{id}
| Address | https://api.hanzo.ai/v1/crm/companies/{id} |
| Method | PUT |
| Operation | put_crm_companies_by_id |
| Auth | Authorization: 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).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID names the company to update and comes from the path. |
arr | body | integer | — | ARR is annual recurring revenue in minor units (cents) of Currency. |
city | body | string | — | City is the head-office city. |
country | body | string | — | Country is the head-office country. |
currency | body | string | — | Currency is the ISO code ARR is denominated in; empty defaults to USD. |
domainName | body | string | — | DomainName is the company's primary domain, e.g. |
employees | body | integer | — | Employees is the headcount. |
id | body | string | — | ID names the company to update and comes from the path. |
idealCustomerProfile | body | boolean | — | ICP marks the company as an ideal-customer-profile fit. |
linkedinLink | body | string | — | Linkedin is the company's LinkedIn URL. |
name | body | string | — | Name is the company name. |
xLink | body | string | — | XLink is the company's X (Twitter) URL. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Company | ok |
200 body — 13 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
arr | body | integer | — | ARR is annual recurring revenue in minor units (cents) of Currency. |
city | body | string | — | City is the head-office city. |
country | body | string | — | Country is the head-office country. |
createdAt | body | integer | — | CreatedAt is the unix second the company was created. |
currency | body | string | — | Currency is the ISO code ARR is denominated in; a write that names none stores USD. |
domainName | body | string | — | DomainName is the company's primary domain, e.g. |
employees | body | integer | — | Employees is the headcount. |
id | body | string | — | ID is the server-minted company id ("comp_" + 128 random bits). |
idealCustomerProfile | body | boolean | — | ICP marks the company as an ideal-customer-profile fit. |
linkedinLink | body | string | — | Linkedin is the company's LinkedIn URL. |
name | body | string | — | Name is the company name. |
updatedAt | body | integer | — | UpdatedAt is the unix second of the last write. |
xLink | body | string | — | XLink is the company's X (Twitter) URL. |
Failure carries the platform error shape — see Errors.
Examples
hanzo crm companies set <id>import { Configuration, CrmApi } from 'hanzoai';
const api = new CrmApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putCrmCompaniesById({ id: 'id', arr: 0, city: "<city>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CrmApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CrmApi(client).put_crm_companies_by_id(id='id', arr=0, city="<city>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CrmAPI.PutCrmCompaniesById(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, crm_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = crm_api::put_crm_companies_by_id(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CrmApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CrmApi(client).putCrmCompaniesById();curl -X PUT https://api.hanzo.ai/v1/crm/companies/<id> \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"arr": 0,
"city": "<city>"
}'The door reaches crm through the crm tool, which names its 20 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_crm_applications"
}
}
}'How is this guide?