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-10-08T19:16:57.0212927+08:00",
"account_id": "4924932e-3c32-4711-877a-7da3a48f5297",
"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": "6616bd46-0ca5-45bb-bb2b-5a7675e67a4e",
"new_account_email": "sample string 7",
"new_account_mobile": "sample string 8",
"new_account_country": "sample string 9",
"referred_by_id": "934c1a08-3f4b-45cf-94be-9cf5f1a4872d",
"referred_by": "sample string 10",
"referred_to_id": "a1eb3598-e959-49bb-8e8d-5093c1b895c8",
"opportunity_type_id": "56b1f7eb-f6e0-401c-9339-eb517dd32f78",
"opportunity_status_id": "75c4820b-afb6-4be4-a69c-23d938b53f78",
"source_id": "e8b09b31-0098-4a8a-84cf-b9bc283b7ea0",
"source_origin": "sample string 11",
"referral_fee_payable": true,
"notify": true,
"event_registrant_id": "56bd1d3a-1bfd-46b5-883a-e1c5bf18b2c7",
"event_registrant_email": "sample string 14",
"campaign_recipient_id": "0f001df3-bbbb-4d70-96a7-60078a238c85",
"campaign_recipient_to": "sample string 15",
"created_date": "2026-10-08T19:16:57.0212927+08:00",
"external_activity": true,
"id": "a182551e-83fd-4b1d-965a-1f50a44ab98c",
"subscription_id": "9e479524-0e77-4895-8e66-a9b172f4faec",
"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">a182551e-83fd-4b1d-965a-1f50a44ab98c</Id> <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">9e479524-0e77-4895-8e66-a9b172f4faec</SubscriptionId> <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts> <AccountId>4924932e-3c32-4711-877a-7da3a48f5297</AccountId> <AccountName>sample string 2</AccountName> <AutoAccountID>true</AutoAccountID> <CampaignRecipientId>0f001df3-bbbb-4d70-96a7-60078a238c85</CampaignRecipientId> <CampaignRecipientTo>sample string 15</CampaignRecipientTo> <CreatedDate>2026-10-08T19:16:57.0212927+08:00</CreatedDate> <EventRegistrantEmail>sample string 14</EventRegistrantEmail> <EventRegistrantId>56bd1d3a-1bfd-46b5-883a-e1c5bf18b2c7</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>6616bd46-0ca5-45bb-bb2b-5a7675e67a4e</NewAccountTypeId> <Notify>true</Notify> <OpportunityDate>2026-10-08T19:16:57.0212927+08:00</OpportunityDate> <OpportunityStatusId>75c4820b-afb6-4be4-a69c-23d938b53f78</OpportunityStatusId> <OpportunityTypeId>56b1f7eb-f6e0-401c-9339-eb517dd32f78</OpportunityTypeId> <ReferralFeePayable>true</ReferralFeePayable> <ReferredBy>sample string 10</ReferredBy> <ReferredById>934c1a08-3f4b-45cf-94be-9cf5f1a4872d</ReferredById> <ReferredToId>a1eb3598-e959-49bb-8e8d-5093c1b895c8</ReferredToId> <SourceId>e8b09b31-0098-4a8a-84cf-b9bc283b7ea0</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.