PUT api/opportunities/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

OpportunityUpdateModel
NameDescriptionTypeAdditional information
lead_status_id

globally unique identifier

None.

account_id

globally unique identifier

None.

opportunity_type_id

globally unique identifier

None.

enquiry_type

string

None.

enquiry_type_tag_id

EnquiryTypeTagID

None.

enquiry_type_color

string

None.

enquiry_type_icon

string

None.

opportunity_type

string

None.

referred_by_id

globally unique identifier

None.

referred_by

string

None.

referred_to_id

globally unique identifier

None.

original_referred_to_id

globally unique identifier

None.

referred_to

string

None.

opportunity_date

date

None.

source_id

globally unique identifier

None.

source_origin

string

None.

nav_opportunity_status_id

globally unique identifier

None.

opportunity_status_id

globally unique identifier

None.

opportunity_status

string

None.

home_design_id

globally unique identifier

None.

development_id

globally unique identifier

None.

syndicate_id

globally unique identifier

None.

sale_property_id

globally unique identifier

None.

sale_property_address

string

None.

real_property_id

globally unique identifier

None.

real_property_address

string

None.

reference_no

string

None.

currency_id

globally unique identifier

None.

referral_fee

decimal number

None.

work_date

date

None.

paid_date

date

None.

transaction_completion_date

date

None.

transaction_amount

decimal number

None.

transaction_completed

boolean

None.

referral_fee_payable

boolean

None.

original_notes

string

None.

notes

string

None.

mark_as_deleted

boolean

None.

event_registrant_id

globally unique identifier

None.

survey_id

globally unique identifier

None.

survey_response_id

globally unique identifier

None.

created_remotely

boolean

None.

parent_opportunity_id

globally unique identifier

None.

created_date

date

None.

advance_to_enquiry

AdvanceToEnquiryModel

None.

id

globally unique identifier

None.

subscription_id

globally unique identifier

None.

ts

Collection of byte

None.

Request Formats

application/json, text/json

Sample:
{
  "lead_status_id": "8dc944cc-ef2c-4190-b82e-6b9ad072f418",
  "account_id": "7885a487-4326-428a-8c20-b16bee9514ef",
  "opportunity_type_id": "a0a11493-cf18-4620-bdf5-9a457e211541",
  "enquiry_type": "sample string 3",
  "enquiry_type_tag_id": 0,
  "enquiry_type_color": "sample string 4",
  "enquiry_type_icon": "sample string 5",
  "opportunity_type": "sample string 6",
  "referred_by_id": "d73bb41c-2537-4b9b-a7d8-e7980971fccc",
  "referred_by": "sample string 7",
  "referred_to_id": "4dc90621-7716-4975-a571-a0d210930d48",
  "original_referred_to_id": "49c90d72-bdae-4642-9b79-97102bdb136b",
  "referred_to": "sample string 8",
  "opportunity_date": "2026-06-09T14:55:42.4788664+08:00",
  "source_id": "c77dfbcd-44bf-4c79-983f-9ef35e44c120",
  "source_origin": "sample string 10",
  "nav_opportunity_status_id": "25f3a617-426f-49d4-8492-8a05ddeb3d18",
  "opportunity_status_id": "07e8614b-a8d4-4dac-adf9-f135c053d5f9",
  "opportunity_status": "sample string 11",
  "home_design_id": "2b124d9b-f155-4b89-81d2-fa99598ac9d8",
  "development_id": "dd68e8ba-af99-48f5-891d-b32007a321f7",
  "syndicate_id": "45d769d5-24e3-4537-ae1c-4935187f31ab",
  "sale_property_id": "5bbc8543-c42d-4170-86bd-22cac6efc7d8",
  "sale_property_address": "sample string 12",
  "real_property_id": "174995d4-d72a-4b36-9ce8-3fb0ea1dcb97",
  "real_property_address": "sample string 13",
  "reference_no": "sample string 14",
  "currency_id": "ca8be25f-c713-4995-b66e-3c6d45021eb1",
  "referral_fee": 15.0,
  "work_date": "2026-06-09T14:55:42.4788664+08:00",
  "paid_date": "2026-06-09T14:55:42.4788664+08:00",
  "transaction_completion_date": "2026-06-09T14:55:42.4788664+08:00",
  "transaction_amount": 16.0,
  "transaction_completed": true,
  "referral_fee_payable": true,
  "original_notes": "sample string 19",
  "notes": "sample string 20",
  "mark_as_deleted": true,
  "event_registrant_id": "35f24219-dc81-4f8a-9c22-0d32c222ad53",
  "survey_id": "9813e264-4345-4039-8f64-9f1885195ce9",
  "survey_response_id": "fb48ed35-f473-4816-b19c-d2c2f24edfee",
  "created_remotely": true,
  "parent_opportunity_id": "f526ad83-3366-4e84-ae68-114b70541d07",
  "created_date": "2026-06-09T14:55:42.4788664+08:00",
  "advance_to_enquiry": {
    "new_opportunity_status_id": "15fd0b4c-1269-4b4f-ac82-b5e90e60c0be",
    "css_classes": "sample string 1",
    "html_styles": "sample string 2",
    "opportunity_status_append_to": "sample string 3"
  },
  "id": "1892de7d-4fe3-4924-a857-0645cd2a4e05",
  "subscription_id": "6d0a5298-6a81-4211-bbcf-023e68d64aba",
  "ts": "QEA="
}

application/xml, text/xml

Sample:
<OpportunityUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
  <Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">1892de7d-4fe3-4924-a857-0645cd2a4e05</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">6d0a5298-6a81-4211-bbcf-023e68d64aba</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>7885a487-4326-428a-8c20-b16bee9514ef</AccountId>
  <AdvanceToEnquiryModel>
    <CssClasses>sample string 1</CssClasses>
    <HtmlStyles>sample string 2</HtmlStyles>
    <NewOpportunityStatusId>15fd0b4c-1269-4b4f-ac82-b5e90e60c0be</NewOpportunityStatusId>
    <OpportunityStatusAppendTo>sample string 3</OpportunityStatusAppendTo>
  </AdvanceToEnquiryModel>
  <CreatedDate>2026-06-09T14:55:42.4788664+08:00</CreatedDate>
  <CreatedRemotely>true</CreatedRemotely>
  <CurrencyId>ca8be25f-c713-4995-b66e-3c6d45021eb1</CurrencyId>
  <DevelopmentId>dd68e8ba-af99-48f5-891d-b32007a321f7</DevelopmentId>
  <EnquiryType>sample string 3</EnquiryType>
  <EnquiryTypeColor>sample string 4</EnquiryTypeColor>
  <EnquiryTypeIcon>sample string 5</EnquiryTypeIcon>
  <EnquiryTypeTagID>None</EnquiryTypeTagID>
  <EventRegistrantId>35f24219-dc81-4f8a-9c22-0d32c222ad53</EventRegistrantId>
  <HomeDesignId>2b124d9b-f155-4b89-81d2-fa99598ac9d8</HomeDesignId>
  <LeadStatusId>8dc944cc-ef2c-4190-b82e-6b9ad072f418</LeadStatusId>
  <MarkAsDeleted>true</MarkAsDeleted>
  <NavOpportunityStatusId>25f3a617-426f-49d4-8492-8a05ddeb3d18</NavOpportunityStatusId>
  <Notes>sample string 20</Notes>
  <OpportunityDate>2026-06-09T14:55:42.4788664+08:00</OpportunityDate>
  <OpportunityStatus>sample string 11</OpportunityStatus>
  <OpportunityStatusId>07e8614b-a8d4-4dac-adf9-f135c053d5f9</OpportunityStatusId>
  <OpportunityType>sample string 6</OpportunityType>
  <OpportunityTypeId>a0a11493-cf18-4620-bdf5-9a457e211541</OpportunityTypeId>
  <OriginalNotes>sample string 19</OriginalNotes>
  <OriginalReferredToId>49c90d72-bdae-4642-9b79-97102bdb136b</OriginalReferredToId>
  <PaidDate>2026-06-09T14:55:42.4788664+08:00</PaidDate>
  <ParentOpportunityId>f526ad83-3366-4e84-ae68-114b70541d07</ParentOpportunityId>
  <ReferenceNo>sample string 14</ReferenceNo>
  <ReferralFee>15</ReferralFee>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 7</ReferredBy>
  <ReferredById>d73bb41c-2537-4b9b-a7d8-e7980971fccc</ReferredById>
  <ReferredTo>sample string 8</ReferredTo>
  <ReferredToId>4dc90621-7716-4975-a571-a0d210930d48</ReferredToId>
  <RentalPropertyAddress>sample string 13</RentalPropertyAddress>
  <RentalPropertyId>174995d4-d72a-4b36-9ce8-3fb0ea1dcb97</RentalPropertyId>
  <SalePropertyAddress>sample string 12</SalePropertyAddress>
  <SalePropertyId>5bbc8543-c42d-4170-86bd-22cac6efc7d8</SalePropertyId>
  <SourceId>c77dfbcd-44bf-4c79-983f-9ef35e44c120</SourceId>
  <SourceOrigin>sample string 10</SourceOrigin>
  <SurveyId>9813e264-4345-4039-8f64-9f1885195ce9</SurveyId>
  <SurveyResponseId>fb48ed35-f473-4816-b19c-d2c2f24edfee</SurveyResponseId>
  <SyndicateId>45d769d5-24e3-4537-ae1c-4935187f31ab</SyndicateId>
  <TransactionAmount>16</TransactionAmount>
  <TransactionCompleted>true</TransactionCompleted>
  <TransactionCompletionDate>2026-06-09T14:55:42.4788664+08:00</TransactionCompletionDate>
  <WorkDate>2026-06-09T14:55:42.4788664+08:00</WorkDate>
</OpportunityUpdateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.