Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sales suggestion is active. The values are Y and N.",
            "nullable":false,
            "default":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion ends.",
            "format":"date",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion starts.",
            "format":"date",
            "nullable":true
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ParentObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the parent object of the suggestion.",
            "nullable":true
        },
        "RecipientResponseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indication of how the user responded to the suggestion.",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the Source Object used to derive the suggestion.",
            "nullable":true
        },
        "Suggestion":{
            "type":"string",
            "description":"The suggestion in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionContext":{
            "type":"string",
            "description":"The suggestion Context in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionReason":{
            "type":"string",
            "description":"The suggestion reason in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionRelatedObjects":{
            "title":"Suggestion Related Objects",
            "type":"array",
            "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
            "items":{
                "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-patch-request"
            }
        },
        "SuggestionSource":{
            "maxLength":64,
            "type":"string",
            "description":"The source of the suggestion.",
            "nullable":false
        },
        "SuggestionType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the suggestion.",
            "nullable":false,
            "default":"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

• Array of: object salesSuggestions-SuggestionRelatedObjects-item-patch-request

{
    "title":"Suggestion Related Objects",
    "type":"array",
    "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
    "items":{
        "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-patch-request"
    }
}

Nested Schema : salesSuggestions-SuggestionRelatedObjects-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "RelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object related to sales suggestion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of object related to sales suggestion.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : salesSuggestions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sales suggestion is active. The values are Y and N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the parent object of the suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientCreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created analyzed text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientCreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientLastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientLastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientLastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientResponseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indication of how the user responded to the suggestion.",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesSuggestionId":{
            "type":"integer",
            "description":"The unique identifier of the sales suggestion.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the Source Object used to derive the suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "Suggestion":{
            "type":"string",
            "description":"The suggestion in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionContext":{
            "type":"string",
            "description":"The suggestion Context in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionReason":{
            "type":"string",
            "description":"The suggestion reason in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuggestionRecipientId":{
            "type":"integer",
            "description":"The intended recipient of the suggestion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuggestionRelatedObjects":{
            "title":"Suggestion Related Objects",
            "type":"array",
            "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
            "items":{
                "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-response"
            }
        },
        "SuggestionSource":{
            "maxLength":64,
            "type":"string",
            "description":"The source of the suggestion.",
            "nullable":false,
            "x-queryable":true
        },
        "SuggestionType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the suggestion.",
            "nullable":false,
            "default":"SUGGESTION",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object salesSuggestions-SuggestionRelatedObjects-item-response

{
    "title":"Suggestion Related Objects",
    "type":"array",
    "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
    "items":{
        "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : salesSuggestions-SuggestionRelatedObjects-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "RelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object related to sales suggestion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of object related to sales suggestion.",
            "nullable":false,
            "x-queryable":true
        },
        "SuggestionRelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the suggestion related object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

SuggestionRelatedObjects

Operation: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/child/SuggestionRelatedObjects

Parameters:

• SuggestionRecipientId: $request.path.SuggestionRecipientId

The suggestion related objects resource is used to view the related objects associated to sales suggestion.

Back to Top