POST v1/account/{id}/opportunity

Creates a new account opportunity for the authenticated user

Request Information

URI Parameters

Name	Description	Type	Additional Information
id	ID of the account you want to add the opportunity to	string	Required.

Body Parameters

Information about a new contract

NewOpportunityModel

Name	Description	Type	Additional Information
AccountID	The Account's unique identifier (Kapta)	string	Required.
Name	Opportunity Name	string	Required.
Description	Description or notes about the account	string	None.
CloseDate	The estimated close date	date	Required.
Value	The total value of the opportunity (no abbreviations)	decimal number	Required.
Stage		string	Required. The is the name of a stage you defined in Kapta. (Case Insensitive)

Request Formats

application/json, text/json, text/html

Sample:

{
  "AccountID": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CloseDate": "2025-05-24T11:05:53.4911881+00:00",
  "Value": 5.1,
  "Stage": "sample string 6"
}

application/xml, text/xml

Sample:

<NewOpportunityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <AccountID>sample string 1</AccountID>
  <CloseDate>2025-05-24T11:05:53.4911881+00:00</CloseDate>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <Stage>sample string 6</Stage>
  <Value>5.1</Value>
</NewOpportunityModel>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "AccountID": "sample string 1",
  "AccountName": "sample string 2",
  "OpportunityID": "sample string 3",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "CRMID": "sample string 6",
  "CloseDate": "2025-05-24T11:05:53.4911881+00:00",
  "Stage": "sample string 8",
  "Value": 9.1,
  "Probability": 10.1,
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
    }
  ],
  "Products": [
    {
      "ProductID": "sample string 1",
      "ProductName": "sample string 2",
      "ProductCode": "sample string 3",
      "ProductFamily": "sample string 4",
      "Description": "sample string 5",
      "DateModified": "2025-05-24T11:05:53.4911881+00:00",
      "DateCreated": "2025-05-24T11:05:53.4911881+00:00",
      "CustomFields": [
        {
          "FieldName": "sample string 1",
          "Type": "sample string 2",
          "StringValue": "sample string 3",
          "DoubleValue": 4.1,
          "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
        },
        {
          "FieldName": "sample string 1",
          "Type": "sample string 2",
          "StringValue": "sample string 3",
          "DoubleValue": 4.1,
          "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
        }
      ]
    },
    {
      "ProductID": "sample string 1",
      "ProductName": "sample string 2",
      "ProductCode": "sample string 3",
      "ProductFamily": "sample string 4",
      "Description": "sample string 5",
      "DateModified": "2025-05-24T11:05:53.4911881+00:00",
      "DateCreated": "2025-05-24T11:05:53.4911881+00:00",
      "CustomFields": [
        {
          "FieldName": "sample string 1",
          "Type": "sample string 2",
          "StringValue": "sample string 3",
          "DoubleValue": 4.1,
          "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
        },
        {
          "FieldName": "sample string 1",
          "Type": "sample string 2",
          "StringValue": "sample string 3",
          "DoubleValue": 4.1,
          "DatetimeValue": "2025-05-24T11:05:53.4911881+00:00"
        }
      ]
    }
  ],
  "DateModified": "2025-05-24T11:05:53.4911881+00:00",
  "DateCreated": "2025-05-24T11:05:53.4911881+00:00",
  "Stages": [
    {
      "Name": "sample string 1",
      "Code": "sample string 2",
      "Probability": 3.1,
      "OrderID": 4
    },
    {
      "Name": "sample string 1",
      "Code": "sample string 2",
      "Probability": 3.1,
      "OrderID": 4
    }
  ],
  "ContactIDList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<OpportunityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <AccountID>sample string 1</AccountID>
  <AccountName>sample string 2</AccountName>
  <CRMID>sample string 6</CRMID>
  <CloseDate>2025-05-24T11:05:53.4911881+00:00</CloseDate>
  <ContactIDList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContactIDList>
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
  </CustomFields>
  <DateCreated>2025-05-24T11:05:53.4911881+00:00</DateCreated>
  <DateModified>2025-05-24T11:05:53.4911881+00:00</DateModified>
  <Description>sample string 5</Description>
  <Name>sample string 4</Name>
  <OpportunityID>sample string 3</OpportunityID>
  <Probability>10.1</Probability>
  <Products>
    <ProductModel>
      <CustomFields>
        <UDFFieldModel>
          <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
          <DoubleValue>4.1</DoubleValue>
          <FieldName>sample string 1</FieldName>
          <StringValue>sample string 3</StringValue>
          <Type>sample string 2</Type>
        </UDFFieldModel>
        <UDFFieldModel>
          <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
          <DoubleValue>4.1</DoubleValue>
          <FieldName>sample string 1</FieldName>
          <StringValue>sample string 3</StringValue>
          <Type>sample string 2</Type>
        </UDFFieldModel>
      </CustomFields>
      <DateCreated>2025-05-24T11:05:53.4911881+00:00</DateCreated>
      <DateModified>2025-05-24T11:05:53.4911881+00:00</DateModified>
      <Description>sample string 5</Description>
      <ProductCode>sample string 3</ProductCode>
      <ProductFamily>sample string 4</ProductFamily>
      <ProductID>sample string 1</ProductID>
      <ProductName>sample string 2</ProductName>
    </ProductModel>
    <ProductModel>
      <CustomFields>
        <UDFFieldModel>
          <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
          <DoubleValue>4.1</DoubleValue>
          <FieldName>sample string 1</FieldName>
          <StringValue>sample string 3</StringValue>
          <Type>sample string 2</Type>
        </UDFFieldModel>
        <UDFFieldModel>
          <DatetimeValue>2025-05-24T11:05:53.4911881+00:00</DatetimeValue>
          <DoubleValue>4.1</DoubleValue>
          <FieldName>sample string 1</FieldName>
          <StringValue>sample string 3</StringValue>
          <Type>sample string 2</Type>
        </UDFFieldModel>
      </CustomFields>
      <DateCreated>2025-05-24T11:05:53.4911881+00:00</DateCreated>
      <DateModified>2025-05-24T11:05:53.4911881+00:00</DateModified>
      <Description>sample string 5</Description>
      <ProductCode>sample string 3</ProductCode>
      <ProductFamily>sample string 4</ProductFamily>
      <ProductID>sample string 1</ProductID>
      <ProductName>sample string 2</ProductName>
    </ProductModel>
  </Products>
  <Stage>sample string 8</Stage>
  <Stages>
    <StageModel>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
      <OrderID>4</OrderID>
      <Probability>3.1</Probability>
    </StageModel>
    <StageModel>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
      <OrderID>4</OrderID>
      <Probability>3.1</Probability>
    </StageModel>
  </Stages>
  <Value>9.1</Value>
</OpportunityModel>