POST api/opportunities

Request Information

URI Parameters

None.

Body Parameters

OpportunityCreateModel
NameDescriptionTypeAdditional information
opportunity_date

date

Required

account_id

globally unique identifier

None.

account_name

string

None.

new_account_fields_hidden

boolean

None.

auto_account_id

boolean

None.

new_account_id

string

String length: inclusive between 0 and 75

new_account_name

string

String length: inclusive between 0 and 255

new_account_type_id

globally unique identifier

None.

new_account_email

string

String length: inclusive between 0 and 255

new_account_mobile

string

String length: inclusive between 0 and 25

new_account_country

string

String length: inclusive between 0 and 75

referred_by_id

globally unique identifier

None.

referred_by

string

None.

referred_to_id

globally unique identifier

None.

opportunity_type_id

globally unique identifier

Required

opportunity_status_id

globally unique identifier

None.

source_id

globally unique identifier

Required

source_origin

string

String length: inclusive between 0 and 255

referral_fee_payable

boolean

None.

notify

boolean

None.

event_registrant_id

globally unique identifier

None.

event_registrant_email

string

None.

campaign_recipient_id

globally unique identifier

None.

campaign_recipient_to

string

None.

created_date

date

None.

external_activity

boolean

None.

id

globally unique identifier

None.

subscription_id

globally unique identifier

None.

ts

Collection of byte

None.

Request Formats

application/json, text/json

Sample:
{
  "opportunity_date": "2026-02-09T19:50:06.5799031+08:00",
  "account_id": "f75e699a-54bb-4910-a31f-8f0244384f2b",
  "account_name": "sample string 2",
  "new_account_fields_hidden": true,
  "auto_account_id": true,
  "new_account_id": "sample string 5",
  "new_account_name": "sample string 6",
  "new_account_type_id": "7e4d28f2-eeed-4256-8925-620aecadfd0a",
  "new_account_email": "sample string 7",
  "new_account_mobile": "sample string 8",
  "new_account_country": "sample string 9",
  "referred_by_id": "bd85cf44-65a3-4094-888b-183d9c158366",
  "referred_by": "sample string 10",
  "referred_to_id": "e95b09fe-eb1f-43a3-a7e2-f8cc31e0c367",
  "opportunity_type_id": "0092493c-3360-4a7e-a8be-14b56da9021a",
  "opportunity_status_id": "3ab9b671-9ec8-4b50-b536-2a83ec98bfe5",
  "source_id": "1ca58447-aa67-4d3f-9a25-acf43bfafb63",
  "source_origin": "sample string 11",
  "referral_fee_payable": true,
  "notify": true,
  "event_registrant_id": "fdd0f149-873f-4fd1-a0b6-2d6b73f654ff",
  "event_registrant_email": "sample string 14",
  "campaign_recipient_id": "cd4e3005-a38e-49c6-8312-723b12ef4c96",
  "campaign_recipient_to": "sample string 15",
  "created_date": "2026-02-09T19:50:06.5799031+08:00",
  "external_activity": true,
  "id": "40f666f4-de7c-4a48-8064-ccdc136e7049",
  "subscription_id": "685ea4f7-9b4a-47bb-a294-7338b5f45c3d",
  "ts": "QEA="
}

application/xml, text/xml

Sample:
<OpportunityCreateModel 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">40f666f4-de7c-4a48-8064-ccdc136e7049</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">685ea4f7-9b4a-47bb-a294-7338b5f45c3d</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>f75e699a-54bb-4910-a31f-8f0244384f2b</AccountId>
  <AccountName>sample string 2</AccountName>
  <AutoAccountID>true</AutoAccountID>
  <CampaignRecipientId>cd4e3005-a38e-49c6-8312-723b12ef4c96</CampaignRecipientId>
  <CampaignRecipientTo>sample string 15</CampaignRecipientTo>
  <CreatedDate>2026-02-09T19:50:06.5799031+08:00</CreatedDate>
  <EventRegistrantEmail>sample string 14</EventRegistrantEmail>
  <EventRegistrantId>fdd0f149-873f-4fd1-a0b6-2d6b73f654ff</EventRegistrantId>
  <ExternalActivity>true</ExternalActivity>
  <NewAccountCountry>sample string 9</NewAccountCountry>
  <NewAccountEmail>sample string 7</NewAccountEmail>
  <NewAccountFieldsHidden>true</NewAccountFieldsHidden>
  <NewAccountID>sample string 5</NewAccountID>
  <NewAccountMobile>sample string 8</NewAccountMobile>
  <NewAccountName>sample string 6</NewAccountName>
  <NewAccountTypeId>7e4d28f2-eeed-4256-8925-620aecadfd0a</NewAccountTypeId>
  <Notify>true</Notify>
  <OpportunityDate>2026-02-09T19:50:06.5799031+08:00</OpportunityDate>
  <OpportunityStatusId>3ab9b671-9ec8-4b50-b536-2a83ec98bfe5</OpportunityStatusId>
  <OpportunityTypeId>0092493c-3360-4a7e-a8be-14b56da9021a</OpportunityTypeId>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 10</ReferredBy>
  <ReferredById>bd85cf44-65a3-4094-888b-183d9c158366</ReferredById>
  <ReferredToId>e95b09fe-eb1f-43a3-a7e2-f8cc31e0c367</ReferredToId>
  <SourceId>1ca58447-aa67-4d3f-9a25-acf43bfafb63</SourceId>
  <SourceOrigin>sample string 11</SourceOrigin>
</OpportunityCreateModel>

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.