Create opportunities setup data
post
/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities
Request
Path Parameters
-
Name(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Id: string
The unique identifier of opportunity setup task.
-
OptyCloseDate: string
Maximum Length:
1000
Default Value:20
The default date on which the opportunity will be closed. -
RequireCloseOptyCompetitor: string
Maximum Length:
1
Default Value:Y
Indicates if you need to enter competitor details before closing an opportunity. -
RequireOptyCloseReason: string
Maximum Length:
1
Default Value:Y
Indicates if you need to indicate the win or loss reason before closing an opportunity. -
SalesMethodNumber: string
Maximum Length:
64
The default sales method number if one isn't provided. -
SalesStages: array
Sales Stages
Title:
Sales Stages
The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
Nested Schema : Sales Stages
Type:
array
Title:
Sales Stages
The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
Show Source
Nested Schema : setupAssistants-Opportunities-SalesStages-item-post-request
Type:
Show Source
object
-
DeletedFlag: boolean
Maximum Length:
2
Default Value:false
Indicates if the sales method can be deleted. -
DescriptionText: string
Maximum Length:
255
The description of the sales stage. -
Name: string
Maximum Length:
50
The name of the sales stage. -
PhaseCd: string
Maximum Length:
30
Default Value:QUALIFICATION-DISCOVERY
The code for phase of sales stage. -
RcmndWinProb: string
Maximum Length:
22
The win probability of sales stage. -
StageStatusCd: string
Maximum Length:
30
Default Value:OPEN
A code indicating the status of the sales stage. -
StgId: integer
The unique identifier of the sales stage.
-
StgOrder: string
Maximum Length:
22
The order in which the sales stage will be displayed.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : setupAssistants-Opportunities-item-response
Type:
Show Source
object
-
Id: string
The unique identifier of opportunity setup task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyCloseDate: string
Maximum Length:
1000
Default Value:20
The default date on which the opportunity will be closed. -
RequireCloseOptyCompetitor: string
Maximum Length:
1
Default Value:Y
Indicates if you need to enter competitor details before closing an opportunity. -
RequireOptyCloseReason: string
Maximum Length:
1
Default Value:Y
Indicates if you need to indicate the win or loss reason before closing an opportunity. -
SalesMethodNumber: string
Maximum Length:
64
The default sales method number if one isn't provided. -
SalesStages: array
Sales Stages
Title:
Sales Stages
The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sales Stages
Type:
array
Title:
Sales Stages
The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : setupAssistants-Opportunities-SalesStages-item-response
Type:
Show Source
object
-
DeletedFlag: boolean
Maximum Length:
2
Default Value:false
Indicates if the sales method can be deleted. -
DescriptionText: string
Maximum Length:
255
The description of the sales stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
50
The name of the sales stage. -
PhaseCd: string
Maximum Length:
30
Default Value:QUALIFICATION-DISCOVERY
The code for phase of sales stage. -
RcmndWinProb: string
Maximum Length:
22
The win probability of sales stage. -
StageNumber: string
Read Only:
true
Maximum Length:64
Default Value:-1
An alternate unique identifier of the stage. -
StageStatusCd: string
Maximum Length:
30
Default Value:OPEN
A code indicating the status of the sales stage. -
StgId: integer
The unique identifier of the sales stage.
-
StgOrder: string
Maximum Length:
22
The order in which the sales stage will be displayed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SalesStages
-
Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStagesParameters:
- Id6:
$request.path.Id6
- Name:
$request.path.Name
The Sales Stages resource is used to create, view and update sales stages for the selected sales method. - Id6: