dealdesk.create_card
Create a desk card with title, stage, owner, priority, customer links, and deal estimates to track opportunities on the desk.
Instructions
Create a desk card (title, stage, optional description, ownerUserId, priority, Customer Directory company/contact, and optional deal estimates: estimatedValue, estimatedValueCurrency, estimatedValuePeriod, probabilityPercent). Resolve owners with dealdesk.list_desk_users. Prefer estimate fields over create_case when the opportunity already lives on the desk.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Deprecated alias for description — prefer description | |
| stage | No | Desk board column id (not a UI label). Resolve with dealdesk.list_desk_stages. Default board: request, request-in-progress, quote-preparation, quote-sent, quote-accepted, order-processing, order-completed, closed. Soft-close with closed. Never invent ids by slugifying labels (e.g. Anfrage in Bearbeitung → request-in-progress, not anfrage-in-bearbeitung). | |
| title | Yes | ||
| priority | No | Card priority label (default normal; free text as shown on the desk). | |
| companyId | No | Customer Directory company id → accountRef on the card | |
| contactId | No | Customer Directory contact id → contactRef on the card | |
| projectId | No | DealDesk project id. Omit when the OAuth token or API key authorizes exactly one project. Required when Connect authorized several projects. | |
| description | No | Card description (main body text shown on the card) | |
| ownerUserId | No | Desk owner user id from dealdesk.list_desk_users | |
| estimatedValue | No | Working forecast amount. Does not rewrite linked quote totals. | |
| deskDescription | No | Local desk-only description (optional; distinct from CRM case description) | |
| probabilityPercent | No | Win chance percent (0–100). | |
| estimatedValuePeriod | No | Labels estimatedValue as one-time, monthly, or yearly. Does not convert the amount. Use year for ARR / per-year (e.g. 4000 EUR per year). Defaults to one_time when omitted on create. | |
| estimatedValueCurrency | No | ISO 4217 alpha-3 currency code (e.g. EUR). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | Yes | Desk card. Null owner/account fields are omitted so hosts that cached an older object-only schema still accept the payload. |