Create an opportunity campaign
post
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
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
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table. -
OptyCampaignId: integer
(int64)
Title:
Opportunity Campaign ID
The unique identifier of the opportunity campaign. -
OptyCampaignNumber: string
Title:
Opportunity Campaign Number
Maximum Length:30
The unique alternate identifier for the Opportunity Campaign. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. It is the reference key to opportunity header. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate identifier for current opportunity. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for the opportunity. -
RevenuePercentage: number
Title:
Revenue Percentage
To store the percentage value of the opportunity's revenue shared by one or more campaigns.
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 : opportunities-OpportunityCampaigns-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 opportunity belongs. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table. -
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 opportunity 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 opportunity campaign data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date and time when this record is created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyCampaignId: integer
(int64)
Title:
Opportunity Campaign ID
The unique identifier of the opportunity campaign. -
OptyCampaignNumber: string
Title:
Opportunity Campaign Number
Maximum Length:30
The unique alternate identifier for the Opportunity Campaign. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. It is the reference key to opportunity header. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate identifier for current opportunity. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for the opportunity. -
RevenuePercentage: number
Title:
Revenue Percentage
To store the percentage value of the opportunity's revenue shared by one or more campaigns.
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: