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": "16d6eeca-7203-4e47-8824-f626bfa78a6d",
  "account_id": "e3b2170c-e393-430a-9e86-c9b37e158399",
  "opportunity_type_id": "c1875907-7378-44bb-a2c3-372c1f64e558",
  "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": "ce75004d-1aaa-47cb-97ee-73bb14c2dc80",
  "referred_by": "sample string 7",
  "referred_to_id": "901ce4d3-04fa-4687-9bb1-e26215953b33",
  "original_referred_to_id": "7c236511-a7ad-4385-844f-b1c3d7a9b2fd",
  "referred_to": "sample string 8",
  "opportunity_date": "2026-04-10T20:19:34.5419287+08:00",
  "source_id": "0aced6f0-ba66-499d-b9cc-e66ae75e7fa7",
  "source_origin": "sample string 10",
  "nav_opportunity_status_id": "d2914a84-50bf-4cd6-9645-d51e819cecaa",
  "opportunity_status_id": "31d6f029-6428-4897-ab9e-08518cccd62a",
  "opportunity_status": "sample string 11",
  "home_design_id": "b064296f-40d0-40d0-ba18-d70d623e75ec",
  "development_id": "3baa6cfb-f028-4486-aeb6-d3e8f0928f4f",
  "syndicate_id": "4d2632c8-62be-41ee-ad27-c95727d390af",
  "sale_property_id": "3428299e-fc68-48be-bf86-7fe4605891d5",
  "sale_property_address": "sample string 12",
  "real_property_id": "a06f520b-11c0-4c3d-bef5-27db072c7a05",
  "real_property_address": "sample string 13",
  "reference_no": "sample string 14",
  "currency_id": "537fe51e-4201-49a6-9a63-53ea85323646",
  "referral_fee": 15.0,
  "work_date": "2026-04-10T20:19:34.5419287+08:00",
  "paid_date": "2026-04-10T20:19:34.5419287+08:00",
  "transaction_completion_date": "2026-04-10T20:19:34.5419287+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": "e6085283-d256-4afa-b527-d9bce7af3452",
  "survey_id": "7b165273-57fb-4172-971d-4e0f46c2cdd1",
  "survey_response_id": "b252fc99-af7c-48e5-8fb5-18ff12964351",
  "created_remotely": true,
  "parent_opportunity_id": "48d1d860-477b-456a-b922-057f6533e8a4",
  "created_date": "2026-04-10T20:19:34.5419287+08:00",
  "advance_to_enquiry": {
    "new_opportunity_status_id": "e1a1195b-bf12-48fb-9d6e-ece6cc145aff",
    "css_classes": "sample string 1",
    "html_styles": "sample string 2",
    "opportunity_status_append_to": "sample string 3"
  },
  "id": "199b466d-590b-4c14-8576-c7a8cdb057aa",
  "subscription_id": "784fe556-5f16-4e17-99f4-ac5290b90ca2",
  "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">199b466d-590b-4c14-8576-c7a8cdb057aa</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">784fe556-5f16-4e17-99f4-ac5290b90ca2</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>e3b2170c-e393-430a-9e86-c9b37e158399</AccountId>
  <AdvanceToEnquiryModel>
    <CssClasses>sample string 1</CssClasses>
    <HtmlStyles>sample string 2</HtmlStyles>
    <NewOpportunityStatusId>e1a1195b-bf12-48fb-9d6e-ece6cc145aff</NewOpportunityStatusId>
    <OpportunityStatusAppendTo>sample string 3</OpportunityStatusAppendTo>
  </AdvanceToEnquiryModel>
  <CreatedDate>2026-04-10T20:19:34.5419287+08:00</CreatedDate>
  <CreatedRemotely>true</CreatedRemotely>
  <CurrencyId>537fe51e-4201-49a6-9a63-53ea85323646</CurrencyId>
  <DevelopmentId>3baa6cfb-f028-4486-aeb6-d3e8f0928f4f</DevelopmentId>
  <EnquiryType>sample string 3</EnquiryType>
  <EnquiryTypeColor>sample string 4</EnquiryTypeColor>
  <EnquiryTypeIcon>sample string 5</EnquiryTypeIcon>
  <EnquiryTypeTagID>None</EnquiryTypeTagID>
  <EventRegistrantId>e6085283-d256-4afa-b527-d9bce7af3452</EventRegistrantId>
  <HomeDesignId>b064296f-40d0-40d0-ba18-d70d623e75ec</HomeDesignId>
  <LeadStatusId>16d6eeca-7203-4e47-8824-f626bfa78a6d</LeadStatusId>
  <MarkAsDeleted>true</MarkAsDeleted>
  <NavOpportunityStatusId>d2914a84-50bf-4cd6-9645-d51e819cecaa</NavOpportunityStatusId>
  <Notes>sample string 20</Notes>
  <OpportunityDate>2026-04-10T20:19:34.5419287+08:00</OpportunityDate>
  <OpportunityStatus>sample string 11</OpportunityStatus>
  <OpportunityStatusId>31d6f029-6428-4897-ab9e-08518cccd62a</OpportunityStatusId>
  <OpportunityType>sample string 6</OpportunityType>
  <OpportunityTypeId>c1875907-7378-44bb-a2c3-372c1f64e558</OpportunityTypeId>
  <OriginalNotes>sample string 19</OriginalNotes>
  <OriginalReferredToId>7c236511-a7ad-4385-844f-b1c3d7a9b2fd</OriginalReferredToId>
  <PaidDate>2026-04-10T20:19:34.5419287+08:00</PaidDate>
  <ParentOpportunityId>48d1d860-477b-456a-b922-057f6533e8a4</ParentOpportunityId>
  <ReferenceNo>sample string 14</ReferenceNo>
  <ReferralFee>15</ReferralFee>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 7</ReferredBy>
  <ReferredById>ce75004d-1aaa-47cb-97ee-73bb14c2dc80</ReferredById>
  <ReferredTo>sample string 8</ReferredTo>
  <ReferredToId>901ce4d3-04fa-4687-9bb1-e26215953b33</ReferredToId>
  <RentalPropertyAddress>sample string 13</RentalPropertyAddress>
  <RentalPropertyId>a06f520b-11c0-4c3d-bef5-27db072c7a05</RentalPropertyId>
  <SalePropertyAddress>sample string 12</SalePropertyAddress>
  <SalePropertyId>3428299e-fc68-48be-bf86-7fe4605891d5</SalePropertyId>
  <SourceId>0aced6f0-ba66-499d-b9cc-e66ae75e7fa7</SourceId>
  <SourceOrigin>sample string 10</SourceOrigin>
  <SurveyId>7b165273-57fb-4172-971d-4e0f46c2cdd1</SurveyId>
  <SurveyResponseId>b252fc99-af7c-48e5-8fb5-18ff12964351</SurveyResponseId>
  <SyndicateId>4d2632c8-62be-41ee-ad27-c95727d390af</SyndicateId>
  <TransactionAmount>16</TransactionAmount>
  <TransactionCompleted>true</TransactionCompleted>
  <TransactionCompletionDate>2026-04-10T20:19:34.5419287+08:00</TransactionCompletionDate>
  <WorkDate>2026-04-10T20:19:34.5419287+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.