Create a deal

POST/api/v1/o2c/deals

Create a pipeline deal. Provide either prospect_name (before a real customer record exists) or customer_id (an expansion deal on an existing customer). stage defaults to prospecting.

Operation ID: create_deal·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: DealCreate

prospect_namestring: Free-text prospect/company name, used before a real customer record exists. Required unless customer_id is set.
customer_idstring: Existing customer this deal is for (expansion deal). Required unless prospect_name is set.
namestring: Deal name. Defaults to the prospect/customer name.
contact_namestring: Sales contact.
contact_emailstring: Sales contact email. Never written to the customer record -- may later become the order signer.
sourcestring: One of ['event', 'expansion', 'inbound', 'other', 'outbound', 'partner', 'referral'].
stagestring: One of ['closed_lost', 'closed_won', 'negotiation', 'proposal', 'prospecting', 'qualified']. Defaults to 'prospecting'.
is_expansionboolean: True if this is expansion revenue on an existing customer.
expected_value_centsinteger: Estimated deal value in cents.
expected_hoursnumber | string: Estimated hours.
expected_term_monthsinteger: Estimated contract term in months.
expected_start_datestring · date: Estimated start date.
expected_close_datestring · date: Estimated close date.
notesstring: Free-text notes.
owner_namestring: Sales rep / deal owner. Free text (reps are often not DayZero users); the pipeline's owner filter matches on it exactly.
deal_typestring: Business-defined deal category, e.g. 'Subcontractor', 'EPC', 'Developer'. Free text -- every business slices deals differently.
revenue_typestring: How the money arrives: 'recurring' (monthly) or 'one_time' (prepaid up front).

Responses

201Successful Response

Schema: SuccessEnvelope_DealResponse_

successboolean
messagestring
codestring
dataDealResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing/invalid token or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

POST/api/v1/o2c/deals

bash

curl -X POST 'https://api.ondayzero.com/api/v1/o2c/deals' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "prospect_name": "string",
  "customer_id": "string",
  "name": "string",
  "contact_name": "string",
  "contact_email": "string",
  "source": "string"
}'