Create a campaign member
post
/crmRestApi/resources/11.13.18.05/campaignMembers
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
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. -
CampaignMemberId: integer
(int64)
Title:
Campaign Member ID
The unique identifier of the campaign member. -
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.
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 : campaignMembers-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. -
CampaignMemberId: integer
(int64)
Title:
Campaign Member ID
The unique identifier of the campaign member. -
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 : 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 following properties are defined on the LOV link relation:- Source Attribute: CampaignStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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: Name
- MemberStatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPMEMBER_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: MemberStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: