201Successful Response
Schema: SuccessEnvelope_DealResponse_
successbooleanmessagestringcodestringdataDealResponse
/api/v1/o2c/dealsCreate 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.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: DealCreate
prospect_namestringFree-text prospect/company name, used before a real customer record exists. Required unless customer_id is set.
customer_idstringExisting customer this deal is for (expansion deal). Required unless prospect_name is set.
namestringDeal name. Defaults to the prospect/customer name.
contact_namestringSales contact.
contact_emailstringSales contact email. Never written to the customer record -- may later become the order signer.
sourcestringOne of ['event', 'expansion', 'inbound', 'other', 'outbound', 'partner', 'referral'].
stagestringOne of ['closed_lost', 'closed_won', 'negotiation', 'proposal', 'prospecting', 'qualified']. Defaults to 'prospecting'.
is_expansionbooleanTrue if this is expansion revenue on an existing customer.
expected_value_centsintegerEstimated deal value in cents.
expected_hoursnumber | stringEstimated hours.
expected_term_monthsintegerEstimated contract term in months.
expected_start_datestring · dateEstimated start date.
expected_close_datestring · dateEstimated close date.
notesstringFree-text notes.
Schema: SuccessEnvelope_DealResponse_
successbooleanmessagestringcodestringdataDealResponseSchema: HTTPValidationError
detailarray · ValidationErrorValidationErrorlocarray · string | integerrequiredmsgstringrequiredtypestringrequiredinputobjectctxobject