Create Deal

Open a new deal from a qualified lead.

POST/api/v1/deals/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/deals/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: CREATE_DEAL" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": {
      "amount": "string",
      "currencyCode": "USD"
    },
    "company_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "owner_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "title": "string"
  }'

Authorization

Minimum role: Sales repThe caller must hold this role or a higher one.
Action: CREATE_DEAL

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be CREATE_DEAL for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

amountobjectRequired
No description yet.
2 child fields
- amountstringRequired
  No description yet.
- currencyCodestringRequired
  No description yet.
company_iduuidRequired
No description yet.
owner_iduuidRequired
No description yet.
tenant_iduuidRequired
No description yet.
titlestringRequired
No description yet.
minimum length 1
maximum length 200
close_datedate-time or nullOptional
Target expected close date for quarterly revenue forecasting.
deal_typeenumOptional
No description yet.
Allowed values
- NEW_BUSINESS
- RENEWAL
- UPSELL
Default
NEW_BUSINESS
forecast_categoryenumOptional
No description yet.
Allowed values
- PIPELINE
- BEST_CASE
- COMMIT
- OMITTED
- CLOSED
Default
PIPELINE
initial_discount_percentnumber or nullOptional
No description yet.
lead_iduuid or nullOptional
Source lead when the deal is opened via lead conversion (D1 linkage). Absent for deals created directly — legacy callers unaffected.
primary_contact_iduuid or nullOptional
Primary champion contact linking the deal to the buying committee.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send CREATE_DEAL.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below rep or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.