Update a sales suggestion
patch
/crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}
Request
Path Parameters
-
SuggestionRecipientId(required): integer(int64)
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the sales suggestion is active. The values are Y and N. -
EffectiveEndDate: string
(date)
The date when the validity of the suggestion ends.
-
EffectiveStartDate: string
(date)
The date when the validity of the suggestion starts.
-
ParentObjectId: integer
(int64)
The unique identifier of the parent object.
-
ParentObjectType: string
Maximum Length:
64
The type of the parent object of the suggestion. -
RecipientResponseCode: string
Maximum Length:
30
Default Value:NEW
Indication of how the user responded to the suggestion. -
SourceObjectId: integer
(int64)
The unique identifier of the source object.
-
SourceObjectType: string
Maximum Length:
64
The type of the Source Object used to derive the suggestion. -
Suggestion: string
(byte)
The suggestion in Java Script Object Notation.
-
SuggestionContext: string
(byte)
The suggestion Context in Java Script Object Notation.
-
SuggestionReason: string
(byte)
The suggestion reason in Java Script Object Notation.
-
SuggestionRelatedObjects: array
Suggestion Related Objects
Title:
Suggestion Related Objects
The suggestion related objects resource is used to view the related objects associated to sales suggestion. -
SuggestionSource: string
Maximum Length:
64
The source of the suggestion. -
SuggestionType: string
Maximum Length:
64
Default Value:SUGGESTION
The type of the suggestion.
Nested Schema : Suggestion Related Objects
Type:
array
Title:
Suggestion Related Objects
The suggestion related objects resource is used to view the related objects associated to sales suggestion.
Show Source
Nested Schema : salesSuggestions-SuggestionRelatedObjects-item-patch-request
Type:
Show Source
object
-
RelatedObjectId: integer
(int64)
The unique identifier of the object related to sales suggestion.
-
RelatedObjectType: string
Maximum Length:
64
The type of object related to sales suggestion.
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 : salesSuggestions-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the sales suggestion is active. The values are Y and N. -
EffectiveEndDate: string
(date)
The date when the validity of the suggestion ends.
-
EffectiveStartDate: string
(date)
The date when the validity of the suggestion starts.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentObjectId: integer
(int64)
The unique identifier of the parent object.
-
ParentObjectType: string
Maximum Length:
64
The type of the parent object of the suggestion. -
RecipientCreatedBy: string
Read Only:
true
Maximum Length:64
The user who created analyzed text. -
RecipientCreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
RecipientLastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
RecipientLastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
RecipientLastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
RecipientResponseCode: string
Maximum Length:
30
Default Value:NEW
Indication of how the user responded to the suggestion. -
SalesSuggestionId: integer
(int64)
Read Only:
true
The unique identifier of the sales suggestion. -
SourceObjectId: integer
(int64)
The unique identifier of the source object.
-
SourceObjectType: string
Maximum Length:
64
The type of the Source Object used to derive the suggestion. -
Suggestion: string
(byte)
The suggestion in Java Script Object Notation.
-
SuggestionContext: string
(byte)
The suggestion Context in Java Script Object Notation.
-
SuggestionReason: string
(byte)
The suggestion reason in Java Script Object Notation.
-
SuggestionRecipientId: integer
(int64)
The intended recipient of the suggestion.
-
SuggestionRelatedObjects: array
Suggestion Related Objects
Title:
Suggestion Related Objects
The suggestion related objects resource is used to view the related objects associated to sales suggestion. -
SuggestionSource: string
Maximum Length:
64
The source of the suggestion. -
SuggestionType: string
Maximum Length:
64
Default Value:SUGGESTION
The type of the suggestion.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Suggestion Related Objects
Type:
array
Title:
Suggestion Related Objects
The suggestion related objects resource is used to view the related objects associated to sales suggestion.
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 : salesSuggestions-SuggestionRelatedObjects-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedObjectId: integer
(int64)
The unique identifier of the object related to sales suggestion.
-
RelatedObjectType: string
Maximum Length:
64
The type of object related to sales suggestion. -
SuggestionRelatedObjectId: integer
(int64)
The unique identifier of the suggestion related object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SuggestionRelatedObjects
-
Parameters:
- SuggestionRecipientId:
$request.path.SuggestionRecipientId
The suggestion related objects resource is used to view the related objects associated to sales suggestion. - SuggestionRecipientId: