PUT api/opportunities/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

OpportunityUpdateModel

Name	Type	Additional 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": "77728cbc-5e00-42a1-9f15-e185d99c34be",
  "account_id": "d01bb20d-c7ab-493e-9bbd-39770b72ea9f",
  "opportunity_type_id": "6622459a-0d0c-4f10-9d4d-01fbd0f1a7ee",
  "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": "a3a20905-8b55-47c7-a442-504954a87181",
  "referred_by": "sample string 7",
  "referred_to_id": "9c793a0e-a5b4-488f-b8be-4edacc588eee",
  "original_referred_to_id": "8c8117c1-c5e3-4ae6-a486-43ab8036410f",
  "referred_to": "sample string 8",
  "opportunity_date": "2026-08-08T15:01:17.3640984+08:00",
  "source_id": "e76993de-c0db-4f53-ba58-5b821c857879",
  "source_origin": "sample string 10",
  "nav_opportunity_status_id": "ed8a142a-b5b4-4ba9-acaa-42367bded3b1",
  "opportunity_status_id": "44668484-0c94-4506-8013-7dca8fe7da5b",
  "opportunity_status": "sample string 11",
  "home_design_id": "7b46e58d-30e9-4673-87ee-a3303171ce8b",
  "development_id": "5b08df32-157c-44ad-8c40-5e05d0fba912",
  "syndicate_id": "aea753f4-9e46-4731-b304-a2780bbbad20",
  "sale_property_id": "1a65f058-7650-45e7-8b34-f48934b393d2",
  "sale_property_address": "sample string 12",
  "real_property_id": "a8cc741e-2770-4af4-b0ae-115146428cbc",
  "real_property_address": "sample string 13",
  "reference_no": "sample string 14",
  "currency_id": "c0f76751-08f7-4333-990a-a6c0ae9a3a43",
  "referral_fee": 15.0,
  "work_date": "2026-08-08T15:01:17.3640984+08:00",
  "paid_date": "2026-08-08T15:01:17.3640984+08:00",
  "transaction_completion_date": "2026-08-08T15:01:17.3640984+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": "f98e2e07-4cc1-4cd6-a397-6bb43dbefa12",
  "survey_id": "afafc1de-750b-4962-ab98-1013d57ed8f4",
  "survey_response_id": "707af486-75e7-4b7c-abcf-001697af589b",
  "created_remotely": true,
  "parent_opportunity_id": "4a64693f-e8e2-4b76-adc5-0d2afff92fe6",
  "created_date": "2026-08-08T15:01:17.3640984+08:00",
  "advance_to_enquiry": {
    "new_opportunity_status_id": "f18a5f5c-f1d4-4041-942c-1ad95bffcfbc",
    "css_classes": "sample string 1",
    "html_styles": "sample string 2",
    "opportunity_status_append_to": "sample string 3"
  },
  "id": "08264528-90b3-4845-aa17-63f0e98c89d8",
  "subscription_id": "12da829c-4389-4a56-b7d1-56c8ecaeaf5b",
  "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">08264528-90b3-4845-aa17-63f0e98c89d8</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">12da829c-4389-4a56-b7d1-56c8ecaeaf5b</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>d01bb20d-c7ab-493e-9bbd-39770b72ea9f</AccountId>
  <AdvanceToEnquiryModel>
    <CssClasses>sample string 1</CssClasses>
    <HtmlStyles>sample string 2</HtmlStyles>
    <NewOpportunityStatusId>f18a5f5c-f1d4-4041-942c-1ad95bffcfbc</NewOpportunityStatusId>
    <OpportunityStatusAppendTo>sample string 3</OpportunityStatusAppendTo>
  </AdvanceToEnquiryModel>
  <CreatedDate>2026-08-08T15:01:17.3640984+08:00</CreatedDate>
  <CreatedRemotely>true</CreatedRemotely>
  <CurrencyId>c0f76751-08f7-4333-990a-a6c0ae9a3a43</CurrencyId>
  <DevelopmentId>5b08df32-157c-44ad-8c40-5e05d0fba912</DevelopmentId>
  <EnquiryType>sample string 3</EnquiryType>
  <EnquiryTypeColor>sample string 4</EnquiryTypeColor>
  <EnquiryTypeIcon>sample string 5</EnquiryTypeIcon>
  <EnquiryTypeTagID>None</EnquiryTypeTagID>
  <EventRegistrantId>f98e2e07-4cc1-4cd6-a397-6bb43dbefa12</EventRegistrantId>
  <HomeDesignId>7b46e58d-30e9-4673-87ee-a3303171ce8b</HomeDesignId>
  <LeadStatusId>77728cbc-5e00-42a1-9f15-e185d99c34be</LeadStatusId>
  <MarkAsDeleted>true</MarkAsDeleted>
  <NavOpportunityStatusId>ed8a142a-b5b4-4ba9-acaa-42367bded3b1</NavOpportunityStatusId>
  <Notes>sample string 20</Notes>
  <OpportunityDate>2026-08-08T15:01:17.3640984+08:00</OpportunityDate>
  <OpportunityStatus>sample string 11</OpportunityStatus>
  <OpportunityStatusId>44668484-0c94-4506-8013-7dca8fe7da5b</OpportunityStatusId>
  <OpportunityType>sample string 6</OpportunityType>
  <OpportunityTypeId>6622459a-0d0c-4f10-9d4d-01fbd0f1a7ee</OpportunityTypeId>
  <OriginalNotes>sample string 19</OriginalNotes>
  <OriginalReferredToId>8c8117c1-c5e3-4ae6-a486-43ab8036410f</OriginalReferredToId>
  <PaidDate>2026-08-08T15:01:17.3640984+08:00</PaidDate>
  <ParentOpportunityId>4a64693f-e8e2-4b76-adc5-0d2afff92fe6</ParentOpportunityId>
  <ReferenceNo>sample string 14</ReferenceNo>
  <ReferralFee>15</ReferralFee>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 7</ReferredBy>
  <ReferredById>a3a20905-8b55-47c7-a442-504954a87181</ReferredById>
  <ReferredTo>sample string 8</ReferredTo>
  <ReferredToId>9c793a0e-a5b4-488f-b8be-4edacc588eee</ReferredToId>
  <RentalPropertyAddress>sample string 13</RentalPropertyAddress>
  <RentalPropertyId>a8cc741e-2770-4af4-b0ae-115146428cbc</RentalPropertyId>
  <SalePropertyAddress>sample string 12</SalePropertyAddress>
  <SalePropertyId>1a65f058-7650-45e7-8b34-f48934b393d2</SalePropertyId>
  <SourceId>e76993de-c0db-4f53-ba58-5b821c857879</SourceId>
  <SourceOrigin>sample string 10</SourceOrigin>
  <SurveyId>afafc1de-750b-4962-ab98-1013d57ed8f4</SurveyId>
  <SurveyResponseId>707af486-75e7-4b7c-abcf-001697af589b</SurveyResponseId>
  <SyndicateId>aea753f4-9e46-4731-b304-a2780bbbad20</SyndicateId>
  <TransactionAmount>16</TransactionAmount>
  <TransactionCompleted>true</TransactionCompleted>
  <TransactionCompletionDate>2026-08-08T15:01:17.3640984+08:00</TransactionCompletionDate>
  <WorkDate>2026-08-08T15:01:17.3640984+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.