Sales APIs
Saves data to an opportunity stage
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/opportunity-stages/{opportunityStageId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {opportunityStageId} |
Opportunity stage identifier
Integer, minimum 100000, default 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2779, version 18 |
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.
OpportunityStage
This field is optional.
>Name
The name of the stage
This field is optional.
>{String}</Name>Probability
The probability of winning the opportunity when it is in this stage. In percentage.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Integer}</Probability>DaysBeforeWarning
The number of days the opportunity can stay in this stage without causing a warning.
Minimum value: 0
This field is optional.
>{Integer}</DaysBeforeWarning>SortIndex
Index to sort the order of opportunity stages
This field is optional.
>{Integer}</SortIndex>TaskProcessTemplate
Identifier for a processtemplate. Used to create Process and tasks whenever an opportunity reaches the stage.
This field is optional.
>TaskProcessTemplateId
Unique identifier for task process template
Minimum value: 100000
This field is optional.
>{Integer}</TaskProcessTemplateId>OpportunityStage
This field is optional.
": {Name
The name of the stage
This field is optional.
": "{String}",Probability
The probability of winning the opportunity when it is in this stage. In percentage.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Integer}",DaysBeforeWarning
The number of days the opportunity can stay in this stage without causing a warning.
Minimum value: 0
This field is optional.
": "{Integer}",SortIndex
Index to sort the order of opportunity stages
This field is optional.
": "{Integer}",TaskProcessTemplate
Identifier for a processtemplate. Used to create Process and tasks whenever an opportunity reaches the stage.
This field is optional.
": {TaskProcessTemplateId
Unique identifier for task process template
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. |
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 103269 HTTP 400 | Opportunity stage could not be found |