POST api/Opportunity/CreateOpportunity

Request Information

URI Parameters

None.

Body Parameters

CreateOpportunityRequest
NameDescriptionTypeAdditional information
CustomerId

integer

None.

LeadId

integer

None.

UserId

integer

None.

ContactId

integer

None.

SourceId

integer

None.

CampaignId

integer

None.

StageId

integer

None.

PotentialType

integer

None.

ServiceId

integer

None.

FreightPerMonth

integer

None.

WeightPerMonth

integer

None.

Amount

decimal number

None.

ExpectedRevenue

decimal number

None.

Probability

decimal number

None.

ClosingDate

date

None.

PotentialName

string

None.

NextStep

string

None.

Description

string

None.

OriginId

string

None.

DestinationId1

string

None.

DestinationId2

string

None.

DestinationId3

string

None.

DestinationId4

string

None.

DestinationId5

string

None.

CompetitorId

string

None.

CompetitorIds

Collection of integer

None.

RefNo

string

None.

StageDate

date

None.

FileName

string

None.

FileLocation

string

None.

AccountEsapa

string

None.

MarkLeadAsConverted

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "LeadId": 1,
  "UserId": 1,
  "ContactId": 1,
  "SourceId": 1,
  "CampaignId": 1,
  "StageId": 1,
  "PotentialType": 1,
  "ServiceId": 1,
  "FreightPerMonth": 1,
  "WeightPerMonth": 1,
  "Amount": 1.0,
  "ExpectedRevenue": 1.0,
  "Probability": 1.1,
  "ClosingDate": "2026-09-06T16:38:38.3842042+07:00",
  "PotentialName": "sample string 2",
  "NextStep": "sample string 3",
  "Description": "sample string 4",
  "OriginId": "sample string 5",
  "DestinationId1": "sample string 6",
  "DestinationId2": "sample string 7",
  "DestinationId3": "sample string 8",
  "DestinationId4": "sample string 9",
  "DestinationId5": "sample string 10",
  "CompetitorId": "sample string 11",
  "CompetitorIds": [
    1,
    2
  ],
  "RefNo": "sample string 12",
  "StageDate": "2026-09-06T16:38:38.3842042+07:00",
  "FileName": "sample string 13",
  "FileLocation": "sample string 14",
  "AccountEsapa": "sample string 15",
  "MarkLeadAsConverted": true
}

application/xml, text/xml

Sample:
<CreateOpportunityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/apicrm.Models">
  <AccountEsapa>sample string 15</AccountEsapa>
  <Amount>1</Amount>
  <CampaignId>1</CampaignId>
  <ClosingDate>2026-09-06T16:38:38.3842042+07:00</ClosingDate>
  <CompetitorId>sample string 11</CompetitorId>
  <CompetitorIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CompetitorIds>
  <ContactId>1</ContactId>
  <CustomerId>1</CustomerId>
  <Description>sample string 4</Description>
  <DestinationId1>sample string 6</DestinationId1>
  <DestinationId2>sample string 7</DestinationId2>
  <DestinationId3>sample string 8</DestinationId3>
  <DestinationId4>sample string 9</DestinationId4>
  <DestinationId5>sample string 10</DestinationId5>
  <ExpectedRevenue>1</ExpectedRevenue>
  <FileLocation>sample string 14</FileLocation>
  <FileName>sample string 13</FileName>
  <FreightPerMonth>1</FreightPerMonth>
  <LeadId>1</LeadId>
  <MarkLeadAsConverted>true</MarkLeadAsConverted>
  <NextStep>sample string 3</NextStep>
  <OriginId>sample string 5</OriginId>
  <PotentialName>sample string 2</PotentialName>
  <PotentialType>1</PotentialType>
  <Probability>1.1</Probability>
  <RefNo>sample string 12</RefNo>
  <ServiceId>1</ServiceId>
  <SourceId>1</SourceId>
  <StageDate>2026-09-06T16:38:38.3842042+07:00</StageDate>
  <StageId>1</StageId>
  <UserId>1</UserId>
  <WeightPerMonth>1</WeightPerMonth>
</CreateOpportunityRequest>

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.