Update a lead campaign
patch
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}
Request
Path Parameters
-
LeadCampaignId(required): integer(int64)
The unique identifier of the lead campaign.
-
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
-
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The alternate identifier of the campaign number. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for 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-LeadCampaigns-item-response
Type:
Show Source
object
-
CampaignEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when marketing integration campaign ends. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign Name
Read Only:true
Maximum Length:100
The campaign to which the current lead belongs. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The alternate identifier of the campaign number. -
CampaignStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when marketing integration campaign starts. -
CampaignStatus: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_DRAFT
The status of marketing integration campaign. -
CampaignType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of marketing integration campaign. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead campaign record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the lead campaign data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead campaign record. -
LeadCampaignId: integer
(int64)
Title:
Lead Campaign ID
Read Only:true
The unique identifier of the lead campaign. -
LeadCampaignNumber: string
Title:
Lead Campaign Number
Maximum Length:30
The alternate identifier of the lead campaign. Public surrogate key for this table. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead. It is the reference key to lead header. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate identifier for the current lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for 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
- CampaignStatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS
The lookups resource is used to view standard lookup codes. - finder:
- CampaignTypeVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE
The lookups resource is used to view standard lookup codes. - finder: