|
OpportunityPhase
OpportunityPhase is a property of the Opportunity object. It represents an Opportunity Phase lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
OpportunityPhase shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
IsClosed |
boolean |
Indicates if the OpportunityPhase represents a closed condition. |
|
IsWon |
boolean |
Indicates if the OpportunityPhase represents a won condition. |
|
Probability |
float |
Represents the % probability of winning the opportunity. This can be null. |
|
IsQuoted |
boolean |
Indicates if the OpportunityPhase represents a quoted condition. |
List
Description
Returns a list of opportunity phase lookup values.
URL
https://{company}.bluecamroo.com/api/opportunityphase/list
HTTP Method
GET
Data Return
Returns a list of existing opportunityphase objects in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the opportunityphase object to the list of opportunity phase lookup values.
URL
https://{company}.bluecamroo.com/api/opportunityphase/add
HTTP Method
POST
Parameters
An opportunityphase object
Data Return
Returns the opportunityphase in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass an opportunityphase object to replace the specified opportunity phase.
URL
https://{company}.bluecamroo.com/api/opportunityphase/update
HTTP Method
PUT
Parameters
An opportunityphase object
Data Return
Returns the opportunityphase in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified opportunity phase. The phase to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/opportunityphase/delete/{id}
HTTP Method
DELETE
Parameters
None.
Data Return
None.
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|