OpenapiCrm
Adds a deal to the caller's org and answers 201 with the stored record.
Adds a deal to the caller's org and answers 201 with the stored record.
POST /v1/crm/opportunities
| Address | https://api.hanzo.ai/v1/crm/opportunities |
| Method | POST |
| Operation | post_crm_opportunities |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Adds a deal to the caller's org and answers 201 with the stored record. A name is required; the stage defaults to NEW; companyId and pointOfContactId must name records in the same org.
Request
8 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
amount | body | integer | — | Amount is the deal value in minor units (cents) of Currency. |
closeDate | body | integer | — | CloseDate is the expected close, as a unix second (0 = unset). |
companyId | body | string | — | CompanyID links the deal to one of the org's companies. |
currency | body | string | — | Currency is the ISO code Amount is denominated in; empty defaults to USD. |
id | body | string | — | ID names the opportunity to update and comes from the path. |
name | body | string | — | Name is the deal name. |
pointOfContactId | body | string | — | PointOfContact links the deal to one of the org's contacts. |
stage | body | string | — | Stage is the pipeline stage: NEW, SCREENING, MEETING, PROPOSAL or CUSTOMER (case-insensitive). |
Response
| Status | Body | Meaning |
|---|---|---|
201 | Opportunity | created |
201 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
amount | body | integer | — | Amount is the deal value in minor units (cents) of Currency. |
closeDate | body | integer | — | CloseDate is the expected close as a unix second (0 = unset). |
companyId | body | string | — | CompanyID links the deal to one of the org's companies; empty when unlinked, and cleared when that company is deleted. |
createdAt | body | integer | — | CreatedAt is the unix second the opportunity was created. |
currency | body | string | — | Currency is the ISO code Amount is denominated in; a write that names none stores USD. |
id | body | string | — | ID is the server-minted opportunity id ("oppo_" + 128 random bits). |
name | body | string | — | Name is the deal name. |
pointOfContactId | body | string | — | PointOfContact links the deal to one of the org's contacts; empty when unlinked, and cleared when that contact is deleted. |
stage | body | string | — | Stage is the pipeline stage, always one of NEW, SCREENING, MEETING, PROPOSAL or CUSTOMER — stored upper-case whatever case the write used. |
updatedAt | body | integer | — | UpdatedAt is the unix second of the last write. |
Failure carries the platform error shape — see Errors.
Examples
hanzo crm opportunities createimport { Configuration, CrmApi } from 'hanzoai';
const api = new CrmApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postCrmOpportunities({ amount: 0, closeDate: 0 });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).post_crm_opportunities(amount=0, close_date=0)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CrmAPI.PostCrmOpportunities(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::post_crm_opportunities(&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).postCrmOpportunities();curl -X POST https://api.hanzo.ai/v1/crm/opportunities \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount": 0,
"closeDate": 0
}'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?