Create a campaign account attribution criterion
post
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria
Request
Path Parameters
-
CampaignNumber(required): string
The alternate key identifier of the campaign.
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
-
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.
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-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.
Links
- CriteriaTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ATTR_CRITERIA
The following properties are defined on the LOV link relation:- Source Attribute: CriteriaType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceObjectCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ACNT_SEGMENT_OBJ
The following properties are defined on the LOV link relation:- Source Attribute: SourceObjectCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: