POST api/opportunities
Request Information
URI Parameters
None.
Body Parameters
OpportunityCreateModel| Name | Description | Type | Additional 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-06-09T14:55:34.4689853+08:00",
"account_id": "b5894b40-9932-4f51-a1ce-6e21bc92e80e",
"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": "2241b62f-5bc8-4c2c-a55a-ebcc4c3cae26",
"new_account_email": "sample string 7",
"new_account_mobile": "sample string 8",
"new_account_country": "sample string 9",
"referred_by_id": "a019484e-c98f-4c73-932c-fe312daddd85",
"referred_by": "sample string 10",
"referred_to_id": "ccb07aa3-d417-4e4a-a8c9-57a213f596cb",
"opportunity_type_id": "d2301ad3-5694-4f84-9ab3-0109b57351dc",
"opportunity_status_id": "11b63853-67d5-4fc8-b9d0-488c6649623b",
"source_id": "f8302487-73a4-40e6-8f07-3d8065b9f1e6",
"source_origin": "sample string 11",
"referral_fee_payable": true,
"notify": true,
"event_registrant_id": "b65777c3-1e16-40c0-8367-e914f656c79b",
"event_registrant_email": "sample string 14",
"campaign_recipient_id": "e39af112-9c8a-40a8-99e5-3b693e97a7c2",
"campaign_recipient_to": "sample string 15",
"created_date": "2026-06-09T14:55:34.4689853+08:00",
"external_activity": true,
"id": "c465c1a3-424b-4707-9b16-04ae89d46fa8",
"subscription_id": "135449b5-f39c-4096-875d-ecb583d12749",
"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">c465c1a3-424b-4707-9b16-04ae89d46fa8</Id> <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">135449b5-f39c-4096-875d-ecb583d12749</SubscriptionId> <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts> <AccountId>b5894b40-9932-4f51-a1ce-6e21bc92e80e</AccountId> <AccountName>sample string 2</AccountName> <AutoAccountID>true</AutoAccountID> <CampaignRecipientId>e39af112-9c8a-40a8-99e5-3b693e97a7c2</CampaignRecipientId> <CampaignRecipientTo>sample string 15</CampaignRecipientTo> <CreatedDate>2026-06-09T14:55:34.4689853+08:00</CreatedDate> <EventRegistrantEmail>sample string 14</EventRegistrantEmail> <EventRegistrantId>b65777c3-1e16-40c0-8367-e914f656c79b</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>2241b62f-5bc8-4c2c-a55a-ebcc4c3cae26</NewAccountTypeId> <Notify>true</Notify> <OpportunityDate>2026-06-09T14:55:34.4689853+08:00</OpportunityDate> <OpportunityStatusId>11b63853-67d5-4fc8-b9d0-488c6649623b</OpportunityStatusId> <OpportunityTypeId>d2301ad3-5694-4f84-9ab3-0109b57351dc</OpportunityTypeId> <ReferralFeePayable>true</ReferralFeePayable> <ReferredBy>sample string 10</ReferredBy> <ReferredById>a019484e-c98f-4c73-932c-fe312daddd85</ReferredById> <ReferredToId>ccb07aa3-d417-4e4a-a8c9-57a213f596cb</ReferredToId> <SourceId>f8302487-73a4-40e6-8f07-3d8065b9f1e6</SourceId> <SourceOrigin>sample string 11</SourceOrigin> </OpportunityCreateModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.