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-08-08T15:01:17.3640984+08:00",
"account_id": "fd6c8e50-f4d5-49b4-8c0f-7bfa2aceb520",
"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": "14d8dadb-c380-4224-a1e1-adf79d089d5f",
"new_account_email": "sample string 7",
"new_account_mobile": "sample string 8",
"new_account_country": "sample string 9",
"referred_by_id": "792d982e-5e94-427a-9930-cec24847eb7f",
"referred_by": "sample string 10",
"referred_to_id": "f9818c96-f02c-436f-9bb7-fd2067247d25",
"opportunity_type_id": "b69326fc-2c21-4b94-9ca2-31435c0c39a2",
"opportunity_status_id": "2b7e6d98-8c5b-4ae1-bf8d-e6d07bda8341",
"source_id": "517c1caa-cb00-496d-9b87-a3607a596976",
"source_origin": "sample string 11",
"referral_fee_payable": true,
"notify": true,
"event_registrant_id": "95cd13d0-a77b-49e1-b288-25867439c762",
"event_registrant_email": "sample string 14",
"campaign_recipient_id": "ff2191c8-9d9d-45c2-ba88-937ac4f00161",
"campaign_recipient_to": "sample string 15",
"created_date": "2026-08-08T15:01:17.3640984+08:00",
"external_activity": true,
"id": "bb4cce25-8ca7-4a7b-b7f2-12f4bb7e86a3",
"subscription_id": "8b1fddb8-c336-460a-a351-2cd3896d3dfd",
"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">bb4cce25-8ca7-4a7b-b7f2-12f4bb7e86a3</Id> <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">8b1fddb8-c336-460a-a351-2cd3896d3dfd</SubscriptionId> <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts> <AccountId>fd6c8e50-f4d5-49b4-8c0f-7bfa2aceb520</AccountId> <AccountName>sample string 2</AccountName> <AutoAccountID>true</AutoAccountID> <CampaignRecipientId>ff2191c8-9d9d-45c2-ba88-937ac4f00161</CampaignRecipientId> <CampaignRecipientTo>sample string 15</CampaignRecipientTo> <CreatedDate>2026-08-08T15:01:17.3640984+08:00</CreatedDate> <EventRegistrantEmail>sample string 14</EventRegistrantEmail> <EventRegistrantId>95cd13d0-a77b-49e1-b288-25867439c762</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>14d8dadb-c380-4224-a1e1-adf79d089d5f</NewAccountTypeId> <Notify>true</Notify> <OpportunityDate>2026-08-08T15:01:17.3640984+08:00</OpportunityDate> <OpportunityStatusId>2b7e6d98-8c5b-4ae1-bf8d-e6d07bda8341</OpportunityStatusId> <OpportunityTypeId>b69326fc-2c21-4b94-9ca2-31435c0c39a2</OpportunityTypeId> <ReferralFeePayable>true</ReferralFeePayable> <ReferredBy>sample string 10</ReferredBy> <ReferredById>792d982e-5e94-427a-9930-cec24847eb7f</ReferredById> <ReferredToId>f9818c96-f02c-436f-9bb7-fd2067247d25</ReferredToId> <SourceId>517c1caa-cb00-496d-9b87-a3607a596976</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.