CRM APIs
Update provided sales opportunity
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/opportunities/{salesOpportunityId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOpportunityId} |
Sales opportunity identifier
Integer, minimum 100000, default 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 2775, version 15 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
SalesOpportunity
This field is optional.
>Title
The title of the opportunity
This field is optional.
>{String}</Title>Source
The source of this Opportunity/lead (website, conference, marketing campaign....)
Applicable domain values can be found here
This field is optional.
>{Integer}</Source>ExpectedCloseDate
The date when you expect the deal to be closed.
This field is optional.
>{Date}</ExpectedCloseDate>Probability
The probability of winning this opportunity in percentage.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Integer}</Probability>Value
This field is optional.
>UnweightedAmount
The unweighted value of this opportunity (amount)
Minimum value: 0
This field is optional.
>{Integer}</UnweightedAmount>OneTimeRevenueAmount
The value of startup/creation of the opportunity
Minimum value: 0
This field is optional.
>{Integer}</OneTimeRevenueAmount>RecurringRevenueAmount
Monthly reccuring value of the opportunity
Minimum value: 0
This field is optional.
>{Integer}</RecurringRevenueAmount>ContractMonths
Number of months with recurring value
Minimum value: 0
This field is optional.
>{Integer}</ContractMonths>Contact
Contact reference
This field is optional.
>ContactId
Contact identifier
Minimum value: 10000
This field is optional.
>{Integer}</ContactId>Customer
Customer reference
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Assignee
The employee the opportunity is assigned to.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>OpportunityStage
The stage this opportunity is currently in.
This field is optional.
>OpportunityStageId
Opportunity stage identifier
Minimum value: 100000
This field is optional.
>{Integer}</OpportunityStageId>SalesOpportunity
This field is optional.
": {Title
The title of the opportunity
This field is optional.
": "{String}",Source
The source of this Opportunity/lead (website, conference, marketing campaign....)
Applicable domain values can be found here
This field is optional.
": "{Integer}",ExpectedCloseDate
The date when you expect the deal to be closed.
This field is optional.
": "{Date}",Probability
The probability of winning this opportunity in percentage.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Integer}",Value
This field is optional.
": {UnweightedAmount
The unweighted value of this opportunity (amount)
Minimum value: 0
This field is optional.
": "{Integer}",OneTimeRevenueAmount
The value of startup/creation of the opportunity
Minimum value: 0
This field is optional.
": "{Integer}",RecurringRevenueAmount
Monthly reccuring value of the opportunity
Minimum value: 0
This field is optional.
": "{Integer}",ContractMonths
Number of months with recurring value
Minimum value: 0
This field is optional.
": "{Integer}"Contact
Contact reference
This field is optional.
": {ContactId
Contact identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Customer
Customer reference
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Assignee
The employee the opportunity is assigned to.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"OpportunityStage
The stage this opportunity is currently in.
This field is optional.
": {OpportunityStageId
Opportunity stage identifier
Minimum value: 100000
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101013 HTTP 404 | Sub-module not found |
| Error 105887 HTTP 404 | The cause not found. |
| Error 105912 HTTP 400 | Source cannot be found |
| Error 106156 HTTP 400 | Department cannot be empty. |
| Error 106155 HTTP 400 | OccuredAt cannot be empty. |
| Error 105858 HTTP 400 | Responsible cannot be empty. |
| Error 105061 HTTP 400 | Private task cannot be part of a non-private process |
| Error 105062 HTTP 400 | Non-private task cannot be part of a private process |
| Error 105060 HTTP 400 | Private task can be added to a private process only if both were created by the same user |
| Error 107952 HTTP 400 | You are not authorized to change status of this task |
| Error 108114 HTTP 400 | Only pre production tasks can be approved |
| Error 108125 HTTP 403 | You're not authorized to edit the reviewer of this task |
| Error 107327 HTTP 400 | You are not authorized to to approve or reject this task |
| Error 107367 HTTP 400 | Cannot close the task. Unchecked required checklist items remaining. |