Update a lead competitor
patch
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}
Request
Path Parameters
-
LeadCompetitorId(required): integer(int64)
The unique identifier of the lead competitor.
-
leadsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.
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
-
Comments: string
Title:
Comments
Maximum Length:2000
Indicates the comments of the competitor associated with the lead. -
PrimaryFlag: boolean
Title:
PrimaryFlag
Indicates whether the competitor is a primary for the lead. -
ThreatLevelCode: string
Title:
Threat Level Code
Maximum Length:30
Indicates the threat level of the competitor associated with the lead.
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 : leads-LeadCompetitors-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
Indicates the comments of the competitor associated with the lead. -
CompetitorPartyId: integer
(int64)
Title:
Competitor Party ID
The unique identifier of the competitor. -
CompetitorPartyName: string
Title:
Competitor Party Name
Read Only:true
Maximum Length:360
The name of the competitor of the lead. -
CompetitorPartyNumber: string
Title:
Competitor Party Number
Read Only:true
Maximum Length:30
The alternate identifier for competitor of the lead. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead competitor record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the lead competitor data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead competitor record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the sales lead competitor record. -
LeadCompetitorId: integer
(int64)
Title:
Lead Competitor ID
The unique identifier of the lead competitor. -
LeadCompetitorNumber: string
Title:
Lead Competitor Number
Maximum Length:30
The alternate identifier of the lead competitor. Public surrogate key for this table. -
LeadId: integer
(int64)
Title:
Lead Identifier
The unique identifier of the lead. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate key identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
PrimaryFlag
Indicates whether the competitor is a primary for the lead. -
ThreatLevelCode: string
Title:
Threat Level Code
Maximum Length:30
Indicates the threat level of the competitor associated with the lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- CompetitorThreatLevelVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL%2CBindLookupCode%3D{ThreatLevelCode}
The lookups resource is used to view standard lookup codes. - finder: