PUT v1/account/{id}/opportunity/{opportunityid}

Update an account opportunity for the authenticated user

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
id

ID of the account you want to update the opportunity for

string

Required.

opportunityid

ID of the opportunity you want to update

string

Required.

Body Parameters

Information about the opportunity

UpdateOpportunityModel
NameDescriptionTypeAdditional Information
OpportunityID

The Kapta unique ID of the Opportunity

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)

CustomFields

Custom Field List (if they have been defined)

Collection of UDFFieldModel

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "OpportunityID": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CloseDate": "2025-05-24T11:08:21.9692849+00:00",
  "Value": 5.1,
  "Stage": "sample string 6",
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:08:21.9692849+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:08:21.9692849+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateOpportunityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <CloseDate>2025-05-24T11:08:21.9692849+00:00</CloseDate>
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:08:21.9692849+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:08:21.9692849+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
  </CustomFields>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <OpportunityID>sample string 1</OpportunityID>
  <Stage>sample string 6</Stage>
  <Value>5.1</Value>
</UpdateOpportunityModel>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.