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-04-10T20:14:50.2532719+08:00",
  "account_id": "7c88c8a2-2961-41b1-86fc-67ebfdf50ec5",
  "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": "eff16d06-8388-4267-b1d2-1ce1901739a6",
  "new_account_email": "sample string 7",
  "new_account_mobile": "sample string 8",
  "new_account_country": "sample string 9",
  "referred_by_id": "4d6164e0-d8c7-42bf-863b-b9963998748c",
  "referred_by": "sample string 10",
  "referred_to_id": "8f6f6f3b-8895-43b2-b4cd-794efcaad446",
  "opportunity_type_id": "ce430575-ecb7-46a8-8044-15bc1aef48d5",
  "opportunity_status_id": "99d99c49-f4fd-4cbf-bb74-7a74c4b41e04",
  "source_id": "c70e8a5a-c4bd-441f-a8fe-2e6d07081972",
  "source_origin": "sample string 11",
  "referral_fee_payable": true,
  "notify": true,
  "event_registrant_id": "8d6c42d0-4c2c-4079-bac3-69e08e3087a3",
  "event_registrant_email": "sample string 14",
  "campaign_recipient_id": "3246ae0d-0a8b-48ee-9a58-0cd8cefbe83a",
  "campaign_recipient_to": "sample string 15",
  "created_date": "2026-04-10T20:14:50.2532719+08:00",
  "external_activity": true,
  "id": "66a1c562-ef15-4437-96ef-d00ee7035d04",
  "subscription_id": "deaf6dd8-d369-48a9-976d-d9b4b6c7d7e0",
  "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">66a1c562-ef15-4437-96ef-d00ee7035d04</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">deaf6dd8-d369-48a9-976d-d9b4b6c7d7e0</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <AccountId>7c88c8a2-2961-41b1-86fc-67ebfdf50ec5</AccountId>
  <AccountName>sample string 2</AccountName>
  <AutoAccountID>true</AutoAccountID>
  <CampaignRecipientId>3246ae0d-0a8b-48ee-9a58-0cd8cefbe83a</CampaignRecipientId>
  <CampaignRecipientTo>sample string 15</CampaignRecipientTo>
  <CreatedDate>2026-04-10T20:14:50.2532719+08:00</CreatedDate>
  <EventRegistrantEmail>sample string 14</EventRegistrantEmail>
  <EventRegistrantId>8d6c42d0-4c2c-4079-bac3-69e08e3087a3</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>eff16d06-8388-4267-b1d2-1ce1901739a6</NewAccountTypeId>
  <Notify>true</Notify>
  <OpportunityDate>2026-04-10T20:14:50.2532719+08:00</OpportunityDate>
  <OpportunityStatusId>99d99c49-f4fd-4cbf-bb74-7a74c4b41e04</OpportunityStatusId>
  <OpportunityTypeId>ce430575-ecb7-46a8-8044-15bc1aef48d5</OpportunityTypeId>
  <ReferralFeePayable>true</ReferralFeePayable>
  <ReferredBy>sample string 10</ReferredBy>
  <ReferredById>4d6164e0-d8c7-42bf-863b-b9963998748c</ReferredById>
  <ReferredToId>8f6f6f3b-8895-43b2-b4cd-794efcaad446</ReferredToId>
  <SourceId>c70e8a5a-c4bd-441f-a8fe-2e6d07081972</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.