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": "12974864-d81e-4e15-a774-f6f51063c452",
  "account_id": "3f5746cc-eec1-4eaf-8218-c569802a7c13",
  "opportunity_type_id": "57648c92-47bb-48fd-8b86-f78f7bbdbae9",
  "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": "94587ba7-65e4-43f1-8bb9-f828c33122dd",
  "referred_by": "sample string 7",
  "referred_to_id": "01016230-fdcd-42f4-8346-2c42e477dc12",
  "original_referred_to_id": "67e0d386-b1b9-4fc3-b9f0-c5a389f478a0",
  "referred_to": "sample string 8",
  "opportunity_date": "2026-02-09T19:50:32.0075132+08:00",
  "source_id": "3a20d2a3-2ab1-4488-a421-b3a1fcd880d4",
  "source_origin": "sample string 10",
  "nav_opportunity_status_id": "6b40a72a-0e2e-4c2e-857a-3ce738d6a4a5",
  "opportunity_status_id": "ec2886e8-f59b-4f7a-ba36-f43b1163fd23",
  "opportunity_status": "sample string 11",
  "home_design_id": "2ebbbf2a-6402-474a-8615-c028621213d4",
  "development_id": "a893c5d6-df9b-4505-a230-6b7a81fadec5",
  "syndicate_id": "d35a3f68-75da-4d94-b5a0-e01f7d6d5c9d",
  "sale_property_id": "577d978b-3932-43c2-8552-ec1094e4465a",
  "sale_property_address": "sample string 12",
  "real_property_id": "11590721-47f0-489d-a78a-af3508dd34d4",
  "real_property_address": "sample string 13",
  "reference_no": "sample string 14",
  "currency_id": "8702d0a4-e66e-4891-bcd9-7bd4c136b2f6",
  "referral_fee": 15.0,
  "work_date": "2026-02-09T19:50:32.0075132+08:00",
  "paid_date": "2026-02-09T19:50:32.0075132+08:00",
  "transaction_completion_date": "2026-02-09T19:50:32.0075132+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": "3f4b2f70-1727-40f4-9a81-fb55be5c6de9",
  "survey_id": "b6cadc4d-5da6-46c8-84c4-8bf272de20ed",
  "survey_response_id": "83d91f97-4204-4b04-b789-de63c09a3b75",
  "created_remotely": true,
  "parent_opportunity_id": "ab6ec7cd-810b-43e1-a9cc-99b2df1b4b79",
  "created_date": "2026-02-09T19:50:32.0075132+08:00",
  "advance_to_enquiry": {
    "new_opportunity_status_id": "d3222d5b-c679-4c0f-b089-0f15f6b20b1a",
    "css_classes": "sample string 1",
    "html_styles": "sample string 2",
    "opportunity_status_append_to": "sample string 3"
  },
  "id": "be989917-2201-40a5-8bcf-d6f4341d5895",
  "subscription_id": "d8b3590f-cf46-4f1c-81fe-9b0b2e71a128",
  "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">be989917-2201-40a5-8bcf-d6f4341d5895</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">d8b3590f-cf46-4f1c-81fe-9b0b2e71a128</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>3f5746cc-eec1-4eaf-8218-c569802a7c13</AccountId>
  <AdvanceToEnquiryModel>
    <CssClasses>sample string 1</CssClasses>
    <HtmlStyles>sample string 2</HtmlStyles>
    <NewOpportunityStatusId>d3222d5b-c679-4c0f-b089-0f15f6b20b1a</NewOpportunityStatusId>
    <OpportunityStatusAppendTo>sample string 3</OpportunityStatusAppendTo>
  </AdvanceToEnquiryModel>
  <CreatedDate>2026-02-09T19:50:32.0075132+08:00</CreatedDate>
  <CreatedRemotely>true</CreatedRemotely>
  <CurrencyId>8702d0a4-e66e-4891-bcd9-7bd4c136b2f6</CurrencyId>
  <DevelopmentId>a893c5d6-df9b-4505-a230-6b7a81fadec5</DevelopmentId>
  <EnquiryType>sample string 3</EnquiryType>
  <EnquiryTypeColor>sample string 4</EnquiryTypeColor>
  <EnquiryTypeIcon>sample string 5</EnquiryTypeIcon>
  <EnquiryTypeTagID>None</EnquiryTypeTagID>
  <EventRegistrantId>3f4b2f70-1727-40f4-9a81-fb55be5c6de9</EventRegistrantId>
  <HomeDesignId>2ebbbf2a-6402-474a-8615-c028621213d4</HomeDesignId>
  <LeadStatusId>12974864-d81e-4e15-a774-f6f51063c452</LeadStatusId>
  <MarkAsDeleted>true</MarkAsDeleted>
  <NavOpportunityStatusId>6b40a72a-0e2e-4c2e-857a-3ce738d6a4a5</NavOpportunityStatusId>
  <Notes>sample string 20</Notes>
  <OpportunityDate>2026-02-09T19:50:32.0075132+08:00</OpportunityDate>
  <OpportunityStatus>sample string 11</OpportunityStatus>
  <OpportunityStatusId>ec2886e8-f59b-4f7a-ba36-f43b1163fd23</OpportunityStatusId>
  <OpportunityType>sample string 6</OpportunityType>
  <OpportunityTypeId>57648c92-47bb-48fd-8b86-f78f7bbdbae9</OpportunityTypeId>
  <OriginalNotes>sample string 19</OriginalNotes>
  <OriginalReferredToId>67e0d386-b1b9-4fc3-b9f0-c5a389f478a0</OriginalReferredToId>
  <PaidDate>2026-02-09T19:50:32.0075132+08:00</PaidDate>
  <ParentOpportunityId>ab6ec7cd-810b-43e1-a9cc-99b2df1b4b79</ParentOpportunityId>
  <ReferenceNo>sample string 14</ReferenceNo>
  <ReferralFee>15</ReferralFee>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 7</ReferredBy>
  <ReferredById>94587ba7-65e4-43f1-8bb9-f828c33122dd</ReferredById>
  <ReferredTo>sample string 8</ReferredTo>
  <ReferredToId>01016230-fdcd-42f4-8346-2c42e477dc12</ReferredToId>
  <RentalPropertyAddress>sample string 13</RentalPropertyAddress>
  <RentalPropertyId>11590721-47f0-489d-a78a-af3508dd34d4</RentalPropertyId>
  <SalePropertyAddress>sample string 12</SalePropertyAddress>
  <SalePropertyId>577d978b-3932-43c2-8552-ec1094e4465a</SalePropertyId>
  <SourceId>3a20d2a3-2ab1-4488-a421-b3a1fcd880d4</SourceId>
  <SourceOrigin>sample string 10</SourceOrigin>
  <SurveyId>b6cadc4d-5da6-46c8-84c4-8bf272de20ed</SurveyId>
  <SurveyResponseId>83d91f97-4204-4b04-b789-de63c09a3b75</SurveyResponseId>
  <SyndicateId>d35a3f68-75da-4d94-b5a0-e01f7d6d5c9d</SyndicateId>
  <TransactionAmount>16</TransactionAmount>
  <TransactionCompleted>true</TransactionCompleted>
  <TransactionCompletionDate>2026-02-09T19:50:32.0075132+08:00</TransactionCompletionDate>
  <WorkDate>2026-02-09T19:50:32.0075132+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.