Create a campaign
post
/crmRestApi/resources/11.13.18.05/campaigns
Request
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
-
ActualCost: number
Title:
Actual Cost
The actual cost of the campaign. -
BudgetedCost: number
Title:
Budgeted Cost
The budgeted cost of the campaign. -
CampaignAccountAttributionCriteria: array
Campaign Account Attribution Criteria
Title:
Campaign Account Attribution Criteria
The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign. -
CampaignAccounts: array
Campaign Accounts
Title:
Campaign Accounts
The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign. -
CampaignCategory: string
Title:
Category
Maximum Length:30
Default Value:ORA_MARKETING
The category of the campaign. -
CampaignCreatedBy: string
Title:
Campaign Created By
Maximum Length:64
The user who created the campaign record. -
CampaignCreationDate: string
(date-time)
Title:
Campaign Creation Date
The date when the campaign record was created. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignLastUpdateDate: string
(date-time)
Title:
Campaign Last Update Date
The date when the campaign record was last updated. -
CampaignLastUpdatedBy: string
Title:
Campaign Last Updated By
Maximum Length:64
The user who last updated the campaign record. -
CampaignName(required): string
Title:
Name
Maximum Length:100
The name of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The alternate key identifier of the campaign. -
CampaignOrigin: string
Title:
Origin
Maximum Length:30
Default Value:MKT_CAMPAIGN
The origin of the campaign. -
CampaignProducts: array
Campaign Products
Title:
Campaign Products
The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign. -
CampaignRollup: array
Campaign Rollups
Title:
Campaign Rollups
The campaign rollup resource is used to view a campaign rollup. -
CampaignTeam: array
Campaign Teams
Title:
Campaign Teams
The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign. -
CampaignType: string
Title:
Type
Maximum Length:30
The type of the campaign. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:60
Default Value:ORA_WS
The module through which the campaign was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code indicating the currency associated with the campaign, such as USD or GBP. -
Description: string
Title:
Description
Maximum Length:2000
A brief description of the campaign. -
EndDate: string
(date-time)
Title:
End Date
The date when campaign ended. -
MktCampaignMembers: array
Campaign Members
Title:
Campaign Members
The campaign members resource is used to view the members associated with a sales campaign. -
NumberOfAssociatedAccounts: number
Title:
Number of Accounts
The number of accounts associated to sales target campaign. -
NumberOfLeadsErrored: number
Title:
Number of Lead Generation Errors
The number of leads errored for a given sales target campaign. -
NumberOfLeadsGenerated: number
Title:
Number of Leads Generated
The number of leads generated for a given sales target campaign. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the owner of the campaign. -
OwnerPartyName: string
Title:
Owner
Maximum Length:360
The name of the party associated with the campaign owner. -
ParentCampaignId: integer
(int64)
Title:
Parent Campaign ID
The unique identifier of the parent campaign. -
ProductDescription: string
Title:
Product Description
Maximum Length:100
A brief description of the product of the campaign. -
RegionCode: string
Title:
Region Code
Maximum Length:100
The code indicating the region of the campaign. -
SalesContents: array
Sales Contents
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign. -
SalesTargetCampaignDaysToVerify: integer
(int32)
Title:
Validation Period in Days
The period in days during which the generated sales target leads should be validated. -
SalesTargetCampaignEloquaSyncDate: string
(date-time)
Title:
Last Sync to Marketing Date
The date on which this sales target campaign is synced to Eloqua for the first time. -
SalesTargetCampaignStage: string
Title:
Stage
Maximum Length:32
The code indicating the stage of sales target campaign. -
SalesTargetLeadsCreationDate: string
(date-time)
Title:
Last Lead Generation Date
The date on which the sales target leads for this campaign was last generated. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceSystemCampaignId: string
Title:
Source System Campaign ID
Maximum Length:100
The unique identifier of the campaign in the source system. -
SourceSystemEmailId: integer
(int64)
The unique identifier of the Email in the source system.
-
SourceSystemLandingPageId: integer
(int64)
The unique identifier of the Landing Page in the source system.
-
SourceSystemSegmentId: integer
(int64)
The unique identifier of the Segment in the source system.
- SourceSystemSharedListId: integer (int64)
-
StartDate: string
(date-time)
Title:
Start Date
The date when the campaign started. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ORA_DRAFT
The status of the campaign.
Nested Schema : Campaign Account Attribution Criteria
Type:
array
Title:
Campaign Account Attribution Criteria
The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.
Show Source
Nested Schema : Campaign Accounts
Type:
array
Title:
Campaign Accounts
The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.
Show Source
Nested Schema : Campaign Products
Type:
array
Title:
Campaign Products
The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.
Show Source
Nested Schema : Campaign Rollups
Type:
array
Title:
Campaign Rollups
The campaign rollup resource is used to view a campaign rollup.
Show Source
Nested Schema : Campaign Teams
Type:
array
Title:
Campaign Teams
The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.
Show Source
Nested Schema : Campaign Members
Type:
array
Title:
Campaign Members
The campaign members resource is used to view the members associated with a sales campaign.
Show Source
Nested Schema : Sales Contents
Type:
array
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : campaigns-CampaignAccountAttributionCriteria-item-post-request
Type:
Show Source
object
-
CampaignAccountAttrCriteriaId: integer
(int64)
Title:
Campaign Attribution Criteria ID
The unique identifier of the campaign account attribution criterion. -
CampaignAccountAttrCriteriaNumber: string
Title:
Campaign Attribution Criteria Number
Maximum Length:30
The alternate key identifier of the account attribution criterion. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign account. -
CriteriaExpression: string
(byte)
Title:
Criteria Expression
This contains the query expression of criteria chosen on UI. -
CriteriaType: string
Title:
Criteria Type
Maximum Length:30
Indicates whether the criteria defined is inclusion or exclusion. -
ExclusionCriteriaFlag: boolean
Title:
Is Exclusion Criteria
Maximum Length:1
Default Value:false
Indicates whether the Account Attribution criteria is for excluding any account or not. -
SourceObjectAttr: string
Title:
Source Object Attribute
Maximum Length:150
The attribute that holds source object Id value. -
SourceObjectCode: string
Title:
Source Object
Maximum Length:30
The language independent code for an object name.
Nested Schema : schema
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Campaign Account Party ID
The unique identifier of the account associated with the campaign account. -
CampaignAccountId: integer
(int64)
Title:
Campaign Account ID
The unique identifier of the campaign account. -
CampaignAccountNumber: string
Title:
Campaign Account Number
Maximum Length:30
The alternate key identifier of the campaign account. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign account belongs to. -
ErrorDescription: string
Title:
Error Description
Maximum Length:2000
This contains the error message generated during lead generation of this account. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign account. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign account. -
QueryCriteriaType: string
Title:
Query Criteria Type
Maximum Length:10
Default Value:MANUAL
This indicates whether the account is added by query builder or manually.
Nested 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 unique identifier of the campaign to which the campaign product belongs to. -
CampaignProductId: integer
(int64)
Title:
Campaign Product ID
The unique identifier of the campaign product. -
CampaignProductNumber: string
Title:
Campaign Product Number
Maximum Length:30
The alternate key identifier of the campaign product. -
InventoryItemId: integer
(int64)
Title:
Campaign Inventory Item ID
The unique inventory item identifier associated with the campaign product. -
InventoryOrgId: integer
(int64)
Title:
Campaign Inventory Org ID
The unique inventory organization identifier associated with this campaign product. -
ProductGroupId: integer
(int64)
Title:
Campaign Product Group ID
The unique identifier of the product group. -
ProductGroupNumber: string
Title:
Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group.
Nested Schema : campaigns-CampaignTeam-item-post-request
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Campaign Team Member Access Level Code
Maximum Length:30
Default Value:300
The code indicating the access level of a team member. -
ApproverFlag: boolean
Title:
Is Approver
Maximum Length:1
Default Value:false
Indicates whether the team member is approver of the campaign. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign resource belongs to. -
CampaignTeamId: integer
(int64)
Title:
Campaign Team Member ID
The unique identifier of the campaign resource. -
CampaignTeamNumber: string
Title:
Campaign Team Member Number
Maximum Length:30
The alternate key identifier of the campaign resource. -
MemberFunctionCode: string
Title:
Campaign Team Member Function Code
Maximum Length:30
The role of lead contact in the context of this campaign. -
OwnerFlag: boolean
Title:
Owner
Indicates whether this resource is a primary resource for this campaign. -
ResourceId: integer
(int64)
Title:
Campaign Team Member Party ID
The unique identifier associated with this sales campaign resource.
Nested Schema : campaigns-MktCampaignMembers-item-post-request
Type:
Show Source
object
-
CampaignCampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign member belongs to. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign member. -
CampaignMemberId: integer
(int64)
Title:
Campaign Member ID
The unique identifier of the campaign. -
CampaignMemberNumber: string
Title:
Campaign Member Number
Maximum Length:30
The alternate key identifier of the campaign member. -
ContactId: integer
(int64)
Title:
Contact ID
The unique identifier of the party associated with the campaign member. -
ContactPartyNumber: string
Title:
Contact Number
Maximum Length:30
The unique alternate identifier of the contact associated with the campaign member. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:60
Default Value:ORA_WS
The module through which the campaign member can be created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code indicating the currency associated with the campaign member, such as USD or GBP. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the campaign member. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign member. -
LeadLeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign member. -
MemberResponseDate: string
(date-time)
Title:
Response Date
The date when the response is received for the campaign member. -
MemberStatus: string
Title:
Member Status
Maximum Length:30
Default Value:ORA_SENT
The status of the campaign member. -
SourceSystemCampMemberId: string
Title:
Source System Campaign Member ID
Maximum Length:100
The unique identifier of the campaign member in the source system.
Nested Schema : schema
Type:
Show Source
object
-
ContentItemId: string
Title:
Content ID
Maximum Length:64
The internal content item identifier from the source system. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the sales content item. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
Indicates from where the content item is sourced. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether referred sales content item is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Indicates the sequence in which the sales content should appear in a page. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the object associated to the sales content row. -
ParentObjectType: string
Maximum Length:
128
The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public content item identifier from the source system. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The name of the public sales content item. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The name of the customer for which the public content was published. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The date on which the public content item was published. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The link of the public content item.
Nested Schema : campaigns-smartActions-item-post-request
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel(required): string
Title:
Action Name
Maximum Length:256
The consumer friendly Action Name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The REST Resources the Action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the Action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The list of applications that this action can be used in. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass produced. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName(required): string
Title:
Action Name
Maximum Length:256
Uniquely identifies the Action with name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : campaigns-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : campaigns-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
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 : campaigns-item-response
Type:
Show Source
object
-
ActualCost: number
Title:
Actual Cost
The actual cost of the campaign. -
BudgetedCost: number
Title:
Budgeted Cost
The budgeted cost of the campaign. -
CampaignAccountAttributionCriteria: array
Campaign Account Attribution Criteria
Title:
Campaign Account Attribution Criteria
The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign. -
CampaignAccounts: array
Campaign Accounts
Title:
Campaign Accounts
The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign. -
CampaignCategory: string
Title:
Category
Maximum Length:30
Default Value:ORA_MARKETING
The category of the campaign. -
CampaignCreatedBy: string
Title:
Campaign Created By
Maximum Length:64
The user who created the campaign record. -
CampaignCreationDate: string
(date-time)
Title:
Campaign Creation Date
The date when the campaign record was created. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignLastUpdateDate: string
(date-time)
Title:
Campaign Last Update Date
The date when the campaign record was last updated. -
CampaignLastUpdatedBy: string
Title:
Campaign Last Updated By
Maximum Length:64
The user who last updated the campaign record. -
CampaignName: string
Title:
Name
Maximum Length:100
The name of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The alternate key identifier of the campaign. -
CampaignOrigin: string
Title:
Origin
Maximum Length:30
Default Value:MKT_CAMPAIGN
The origin of the campaign. -
CampaignProducts: array
Campaign Products
Title:
Campaign Products
The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign. -
CampaignRollup: array
Campaign Rollups
Title:
Campaign Rollups
The campaign rollup resource is used to view a campaign rollup. -
CampaignTeam: array
Campaign Teams
Title:
Campaign Teams
The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign. -
CampaignType: string
Title:
Type
Maximum Length:30
The type of the campaign. -
CampaignTypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
The display value of the type of the campaign. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:60
Default Value:ORA_WS
The module through which the campaign was created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code indicating the currency associated with the campaign, such as USD or GBP. -
DeleteFlag: boolean
Title:
Can Be Deleted
Read Only:true
Indicates whether the campaign can be deleted by the logged in user. -
Description: string
Title:
Description
Maximum Length:2000
A brief description of the campaign. -
EndDate: string
(date-time)
Title:
End Date
The date when campaign ended. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the campaign. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MktCampaignMembers: array
Campaign Members
Title:
Campaign Members
The campaign members resource is used to view the members associated with a sales campaign. -
NumberOfAssociatedAccounts: number
Title:
Number of Accounts
The number of accounts associated to sales target campaign. -
NumberOfLeadsErrored: number
Title:
Number of Lead Generation Errors
The number of leads errored for a given sales target campaign. -
NumberOfLeadsGenerated: number
Title:
Number of Leads Generated
The number of leads generated for a given sales target campaign. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the owner of the campaign. -
OwnerPartyName: string
Title:
Owner
Maximum Length:360
The name of the party associated with the campaign owner. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The unique alternate identifier of the owner of the campaign. -
ParentCampaignId: integer
(int64)
Title:
Parent Campaign ID
The unique identifier of the parent campaign. -
ParentCampaignName: string
Title:
Parent Campaign Name
Read Only:true
Maximum Length:100
The name of the parent of the campaign. -
ParentCampaignNumber: string
Title:
Parent Campaign Number
Read Only:true
Maximum Length:30
The unique alternate identifier of the parent of the campaign. -
ProductDescription: string
Title:
Product Description
Maximum Length:100
A brief description of the product of the campaign. -
RegionCode: string
Title:
Region Code
Maximum Length:100
The code indicating the region of the campaign. -
SalesContents: array
Sales Contents
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign. -
SalesTargetCampaignDaysToVerify: integer
(int32)
Title:
Validation Period in Days
The period in days during which the generated sales target leads should be validated. -
SalesTargetCampaignEloquaSyncDate: string
(date-time)
Title:
Last Sync to Marketing Date
The date on which this sales target campaign is synced to Eloqua for the first time. -
SalesTargetCampaignStage: string
Title:
Stage
Maximum Length:32
The code indicating the stage of sales target campaign. -
SalesTargetLeadsCreationDate: string
(date-time)
Title:
Last Lead Generation Date
The date on which the sales target leads for this campaign was last generated. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceSystemCampaignId: string
Title:
Source System Campaign ID
Maximum Length:100
The unique identifier of the campaign in the source system. -
SourceSystemEmailId: integer
(int64)
The unique identifier of the Email in the source system.
-
SourceSystemLandingPageId: integer
(int64)
The unique identifier of the Landing Page in the source system.
-
SourceSystemSegmentId: integer
(int64)
The unique identifier of the Segment in the source system.
- SourceSystemSharedListId: integer (int64)
-
StartDate: string
(date-time)
Title:
Start Date
The date when the campaign started. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ORA_DRAFT
The status of the campaign. -
StatusLookupMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The display label of the status of the campaign. -
UpdateFlag: boolean
Title:
Can Be Updated
Read Only:true
Indicates whether the campaign can be updated by the logged in user.
Nested Schema : Campaign Account Attribution Criteria
Type:
array
Title:
Campaign Account Attribution Criteria
The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.
Show Source
Nested Schema : Campaign Accounts
Type:
array
Title:
Campaign Accounts
The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.
Show Source
Nested Schema : Campaign Products
Type:
array
Title:
Campaign Products
The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.
Show Source
Nested Schema : Campaign Rollups
Type:
array
Title:
Campaign Rollups
The campaign rollup resource is used to view a campaign rollup.
Show Source
Nested Schema : Campaign Teams
Type:
array
Title:
Campaign Teams
The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Campaign Members
Type:
array
Title:
Campaign Members
The campaign members resource is used to view the members associated with a sales campaign.
Show Source
Nested Schema : Sales Contents
Type:
array
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : campaigns-CampaignAccountAttributionCriteria-item-response
Type:
Show Source
object
-
CampaignAccountAttrCriteriaId: integer
(int64)
Title:
Campaign Attribution Criteria ID
The unique identifier of the campaign account attribution criterion. -
CampaignAccountAttrCriteriaNumber: string
Title:
Campaign Attribution Criteria Number
Maximum Length:30
The alternate key identifier of the account attribution criterion. -
CampaignCampaignNumber: string
Title:
Campaign Number
Read Only:true
Maximum Length:30
The unique identifier of the campaign to which the campaign account attribution criterion belongs to. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign account. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign account attribution criteria. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign account attribution criteria was created. -
CriteriaExpression: string
(byte)
Title:
Criteria Expression
This contains the query expression of criteria chosen on UI. -
CriteriaType: string
Title:
Criteria Type
Maximum Length:30
Indicates whether the criteria defined is inclusion or exclusion. -
ExclusionCriteriaFlag: boolean
Title:
Is Exclusion Criteria
Maximum Length:1
Default Value:false
Indicates whether the Account Attribution criteria is for excluding any account or not. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the campaign account attribution criteria was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign account attribution criteria. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceObjectAttr: string
Title:
Source Object Attribute
Maximum Length:150
The attribute that holds source object Id value. -
SourceObjectCode: string
Title:
Source Object
Maximum Length:30
The language independent code for an object name.
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.
Nested Schema : campaigns-CampaignAccounts-item-response
Type:
Show Source
object
-
AccountCountry: string
Title:
Country
Read Only:true
The country of the account. -
AccountId: integer
(int64)
Title:
Campaign Account Party ID
The unique identifier of the account associated with the campaign account. -
AccountIndustryClassCode: string
Title:
Primary Industry
Read Only:true
The primary industry class code for the account. -
AccountName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the account party associated with the campaign account. -
AccountPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The unique alternate identifier of the account associated with the campaign account. -
AccountState: string
Title:
State
Read Only:true
Maximum Length:60
The state of the account. -
AccountTotalEmployees: number
Title:
Company Size
Read Only:true
The total number of employees for the account. -
CampaignAccountId: integer
(int64)
Title:
Campaign Account ID
The unique identifier of the campaign account. -
CampaignAccountNumber: string
Title:
Campaign Account Number
Maximum Length:30
The alternate key identifier of the campaign account. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign account belongs to. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign accounts. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign account was created. -
ErrorDescription: string
Title:
Error Description
Maximum Length:2000
This contains the error message generated during lead generation of this account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign account was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign account. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign account. -
LeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the campaign account. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QueryCriteriaType: string
Title:
Query Criteria Type
Maximum Length:10
Default Value:MANUAL
This indicates whether the account is added by query builder or manually.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-CampaignProducts-item-response
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 unique identifier of the campaign to which the campaign product belongs to. -
CampaignProductId: integer
(int64)
Title:
Campaign Product ID
The unique identifier of the campaign product. -
CampaignProductNumber: string
Title:
Campaign Product Number
Maximum Length:30
The alternate key identifier of the campaign product. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign products. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign product was created. -
InventoryItemId: integer
(int64)
Title:
Campaign Inventory Item ID
The unique inventory item identifier associated with the campaign product. -
InventoryOrgId: integer
(int64)
Title:
Campaign Inventory Org ID
The unique inventory organization identifier associated with this campaign product. -
ItemName: string
Title:
Item Description
Read Only:true
Maximum Length:240
The product description where the product is associated with the campaign. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced inventory item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign product was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign product. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductGroupId: integer
(int64)
Title:
Campaign Product Group ID
The unique identifier of the product group. -
ProductGroupName: string
Title:
Display
Read Only:true
Maximum Length:250
The description of the product group where the product group is associated with the campaign. -
ProductGroupNumber: string
Title:
Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-CampaignRollup-item-response
Type:
Show Source
object
-
CampaignId: integer
(int64)
Title:
Campaign Identifier
Read Only:true
The unique identifier of the campaign. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Read Only:true
Maximum Length:15
The corporate currency code for campaign rollups. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfConvertedLeads: number
Title:
Total Converted Leads
Read Only:true
The total number of converted leads associated with the campaign. -
NumberOfLeads: number
Title:
Total Leads
Read Only:true
The total number of leads associated with the campaign. -
NumberOfOpenHotLeads: number
Title:
Total Hot Open Leads
Read Only:true
The total number of unqualified or qualified leads ranked as hot that are associated with the campaign. -
NumberOfOpenLeads: number
Title:
Total Open Leads
Read Only:true
The total number of unqualified or qualified open leads associated with the campaign. -
NumberOfOpenOpportunities: number
Title:
Total Open Opportunities
Read Only:true
The total number of open opportunities associated with the campaign. -
NumberOfOpportunities: number
Title:
Total Opportunities
Read Only:true
The total number of opportunities associated with the campaign. -
NumberOfWonOpportunities: number
Title:
Total Won Opportunities
Read Only:true
The total won opportunities associated with the campaign. -
SumOfAllOpportunitiesRevenue: number
Title:
Total Revenue from Opportunities
Read Only:true
The total revenue of opportunities associated with the campaign. -
SumOfOpenLeadAmount: number
Title:
Total Revenue from Open Leads
Read Only:true
The total amount of the unqualified and qualified leads associated with the campaign. -
SumOfOpenOpportunitiesRevenue: number
Title:
Total Revenue from Open Opportunities
Read Only:true
The total revenue of the open opportunities associated with the campaign. -
SumOfWonOpportunitiesRevenue: number
Title:
Total Revenue from Won Opportunities
Read Only:true
The total revenue of the won opportunities associated with the campaign.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-CampaignTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Campaign Team Member Access Level Code
Maximum Length:30
Default Value:300
The code indicating the access level of a team member. -
ApproverFlag: boolean
Title:
Is Approver
Maximum Length:1
Default Value:false
Indicates whether the team member is approver of the campaign. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign resource belongs to. -
CampaignTeamId: integer
(int64)
Title:
Campaign Team Member ID
The unique identifier of the campaign resource. -
CampaignTeamNumber: string
Title:
Campaign Team Member Number
Maximum Length:30
The alternate key identifier of the campaign resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign resource was created. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address associated with the campaign team resource. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number of the campaign resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
Title:
Campaign Team Member Function Code
Maximum Length:30
The role of lead contact in the context of this campaign. -
OwnerFlag: boolean
Title:
Owner
Indicates whether this resource is a primary resource for this campaign. -
ResourceId: integer
(int64)
Title:
Campaign Team Member Party ID
The unique identifier associated with this sales campaign resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the campaign resource. -
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier associated with this campaign resource. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role of the campaign resource associated with the sales lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-MktCampaignMembers-item-response
Type:
Show Source
object
-
Active: string
Title:
Is Active
Read Only:true
Maximum Length:1
Default Value:Y
Indicates whether the campaign member is active or not. -
CampaignCampaignName: string
Title:
Name
Read Only:true
Maximum Length:100
The name of the campaign to which the campaign member belongs to. -
CampaignCampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign member belongs to. -
CampaignEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when marketing integration campaign ends. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign member. -
CampaignMemberId: integer
(int64)
Title:
Campaign Member ID
The unique identifier of the campaign. -
CampaignMemberNumber: string
Title:
Campaign Member Number
Maximum Length:30
The alternate key identifier of the campaign member. -
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. -
ContactEmail: string
Title:
Contact Email
Read Only:true
Maximum Length:320
The email address of the contact associated with the campaign member. -
ContactId: integer
(int64)
Title:
Contact ID
The unique identifier of the party associated with the campaign member. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the contact party associated with the campaign member. -
ContactPartyNumber: string
Title:
Contact Number
Maximum Length:30
The unique alternate identifier of the contact associated with the campaign member. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign member. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:60
Default Value:ORA_WS
The module through which the campaign member can be created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign member was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code indicating the currency associated with the campaign member, such as USD or GBP. -
DeleteFlag: boolean
Title:
Can Be Deleted
Read Only:true
Indicates whether the campaign member can be deleted by the logged in user. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the campaign member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the campaign member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the campaign member. -
LeadAccountName: string
Title:
Lead Account
Read Only:true
Maximum Length:360
The account name of the lead associated with the campaign member. -
LeadEmail: string
Title:
Lead Email
Read Only:true
Maximum Length:320
The email address of the lead associated with the campaign member. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign member. -
LeadLeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the campaign member. -
LeadLeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign member. -
LeadOwnerName: string
Title:
Lead Owner
Read Only:true
Maximum Length:360
The owner name of the lead associated with the campaign member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberResponseDate: string
(date-time)
Title:
Response Date
The date when the response is received for the campaign member. -
MemberStatus: string
Title:
Member Status
Maximum Length:30
Default Value:ORA_SENT
The status of the campaign member. -
MemberStatusLookupMeaning: string
Title:
Member Status
Read Only:true
Maximum Length:80
The display label for the status of the campaign member. -
SourceSystemCampMemberId: string
Title:
Source System Campaign Member ID
Maximum Length:100
The unique identifier of the campaign member in the source system. -
UpdateFlag: boolean
Title:
Can Be Updated
Read Only:true
Indicates whether the campaign member can be updated by the logged in user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-SalesContents-item-response
Type:
Show Source
object
-
CanDelete: string
Read Only:
true
Default Value:Y
Indicates whether user can delete the content item or not. -
CanUpdate: string
Read Only:
true
Default Value:Y
Indicates whether user can update the content item or not. -
ContentItemId: string
Title:
Content ID
Maximum Length:64
The internal content item identifier from the source system. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the sales content item. -
ContentItemType: string
Read Only:
true
Indicates the type of content, for example pdf, png, and so on. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
Indicates from where the content item is sourced. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether referred sales content item is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Indicates the sequence in which the sales content should appear in a page. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the object associated to the sales content row. -
ParentObjectType: string
Maximum Length:
128
The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public content item identifier from the source system. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The name of the public sales content item. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The name of the customer for which the public content was published. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The date on which the public content item was published. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The link of the public content item. -
SalesContentId: integer
(int64)
Title:
Sales Content ID
Read Only:true
The unique identifier of the sales content.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The consumer friendly Action Name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The REST Resources the Action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the Action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The list of applications that this action can be used in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass produced. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
Uniquely identifies the Action with name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : campaigns-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : campaigns-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CampaignAccountAttributionCriteria
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign. - CampaignNumber:
- CampaignAccounts
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign. - CampaignNumber:
- CampaignCategoryVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_CATEGORY
The following properties are defined on the LOV link relation:- Source Attribute: CampaignCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampaignOriginVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{CampaignOrigin}%2CBindLookupType%3DORA_MKT_CAMPAIGN_ORIGIN
The following properties are defined on the LOV link relation:- Source Attribute: CampaignOrigin; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampaignProducts
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign. - CampaignNumber:
- CampaignRollup
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign rollup resource is used to view a campaign rollup. - CampaignNumber:
- CampaignStageVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STAGE
The following properties are defined on the LOV link relation:- Source Attribute: SalesTargetCampaignStage; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampaignTeam
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign. - CampaignNumber:
- CampaignTypeVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: CampaignType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CreatedByModuleVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMP_CREATED_BY_MOD
The following properties are defined on the LOV link relation:- Source Attribute: CreatedByModule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CurrencyCodeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- MktCampaignMembers
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The campaign members resource is used to view the members associated with a sales campaign. - CampaignNumber:
- OwnerPickerVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesParameters:
- finder:
FilterByManagerReportsFlagRF
The following properties are defined on the LOV link relation:- Source Attribute: OwnerPartyName; Target Attribute: PartyName
- Display Attribute: PartyName
- finder:
- SalesContents
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign. - CampaignNumber:
- StatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- smartActions
-
Parameters:
- CampaignNumber:
$request.path.CampaignNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - CampaignNumber: