PUT api/consumer/v1/opportunities/{opportunityId}
Update an existing Opportunity
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| opportunityId |
ID of the Opportunity |
integer |
Required |
Body Parameters
New Opportunity informations
OpportunityEditDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Number |
Opportunity Number |
integer |
None |
| OrganizationalUnitId |
Organizational Unit |
integer |
None |
| OpportunityTypeId |
Type of the opportunity |
integer |
None |
| CustomerId |
Customer |
integer |
None |
| EstimatedValue |
Amount of the estimated value |
decimal number |
None |
| IsDeleted |
True if the opportunity is logically deleted |
boolean |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Id |
Unique ID |
integer |
None |
Request Formats
application/json, text/json
Sample:
{
"Number": 1,
"OrganizationalUnitId": 2,
"OpportunityTypeId": 3,
"CustomerId": 4,
"EstimatedValue": 5.0,
"IsDeleted": true,
"Code": "sample string 7",
"Description": "sample string 8",
"IsActive": true,
"Id": 10
}
application/xml, text/xml
Sample:
<OpportunityEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models"> <Id>10</Id> <Code>sample string 7</Code> <Description>sample string 8</Description> <IsActive>true</IsActive> <CustomerId>4</CustomerId> <EstimatedValue>5</EstimatedValue> <IsDeleted>true</IsDeleted> <Number>1</Number> <OpportunityTypeId>3</OpportunityTypeId> <OrganizationalUnitId>2</OrganizationalUnitId> </OpportunityEditDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
200
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None |
|
| Content | HttpContent |
None |
|
| StatusCode | HttpStatusCode |
None |
|
| ReasonPhrase | string |
None |
|
| Headers | Collection of Object |
None |
|
| RequestMessage | HttpRequestMessage |
None |
|
| IsSuccessStatusCode | boolean |
None |