API

Sales APIs

POST sales/opportunity-stages

Creates a new stage for opportunities

HTTP method POST
URI https://api.rambase.net/sales/opportunity-stages
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2778, version 10

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.

Format:
1
<OpportunityStage>
2
     <Name
Name

Required/mandatory field

The name of the stage

>{String}</Name>
3
     <Probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

Minimum value: 0

Maximum value: 100

Default value: 100

This field is optional.

>{Integer}</Probability>
4
     <DaysBeforeWarning
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>
5
</OpportunityStage>
1
{
2
     "opportunityStage": {
3
          "name
Name

Required/mandatory field

The name of the stage

": "{String}",
4
          "probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

Minimum value: 0

Maximum value: 100

Default value: 100

This field is optional.

": "{Integer}",
5
          "daysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

Minimum value: 0

This field is optional.

": "{Integer}"
6
     }
7
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<OpportunityStage>
2
     <OpportunityStageId
OpportunityStageId

Opportunity stage identifier

>{Integer}</OpportunityStageId>
3
     <Status
Status

The status of an opportunity stage

Possible domain values can be found here

>{String}</Status>
4
     <Name
Name

The name of the stage

>{String}</Name>
5
     <Probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

>{Integer}</Probability>
6
     <DaysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

>{Integer}</DaysBeforeWarning>
7
     <SortIndex
SortIndex

Index to sort the order of opportunity stages

>{Integer}</SortIndex>
8
     <TaskProcessTemplate
TaskProcessTemplate

Identifier for a processtemplate. Used to create Process and tasks whenever an opportunity reaches the stage.

>
9
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

>{Integer}</TaskProcessTemplateId>
10
          <Name
Name

Name of the task process template

>{String}</Name>
11
          <TaskProcessTemplateLink
TaskProcessTemplateLink

Task process template reference

>{String}</TaskProcessTemplateLink>
12
     </TaskProcessTemplate>
13
</OpportunityStage>
1
{
2
     "opportunityStage": {
3
          "opportunityStageId
OpportunityStageId

Opportunity stage identifier

": "{Integer}",
4
          "status
Status

The status of an opportunity stage

Possible domain values can be found here

": "{String}",
5
          "name
Name

The name of the stage

": "{String}",
6
          "probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

": "{Integer}",
7
          "daysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

": "{Integer}",
8
          "sortIndex
SortIndex

Index to sort the order of opportunity stages

": "{Integer}",
9
          "taskProcessTemplate
TaskProcessTemplate

Identifier for a processtemplate. Used to create Process and tasks whenever an opportunity reaches the stage.

": {
10
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

": "{Integer}",
11
               "name
Name

Name of the task process template

": "{String}",
12
               "taskProcessTemplateLink
TaskProcessTemplateLink

Task process template reference

": "{String}"
13
          }
14
     }
15
}

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
Error 103809 HTTP 403 Max 10 stages is allowed