Skip to content

Latest commit

 

History

History
403 lines (209 loc) · 7.79 KB

campaign-member-details.schema.md

File metadata and controls

403 lines (209 loc) · 7.79 KB

XDM Business Campaign Member Details Schema

https://ns.adobe.com/xdm/context/campaign-member-details

An XDM Business Campaign Member.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/campaign-member/campaign-member-details.schema.json

Schema Hierarchy

  • XDM Business Campaign Member Details https://ns.adobe.com/xdm/context/campaign-member-details
    • B2B Source https://ns.adobe.com/xdm/datatypes/b2b-source
    • Record Status https://ns.adobe.com/xdm/mixins/record-status

XDM Business Campaign Member Details Example

{
  "xdm:campaignMember": {
    "xdm:type": "Lead",
    "xdm:ID": "18765386"
  },
  "xdm:response": {
    "xdm:hasResponded": true,
    "xdm:respondDate": "2020-05-19T00:00:00+00:00"
  },
  "xdm:campaignProgram": {
    "xdm:ID": "1",
    "xdm:type": "Webinar",
    "xdm:step": {
      "xdm:number": 10,
      "xdm:status": "Invited"
    }
  },
  "xdm:sourceType": "salesforce",
  "xdm:isDeleted": false
}

XDM Business Campaign Member Details Properties

Property Type Required Defined by
xdm:acquiredByCampaignID string Optional XDM Business Campaign Member Details (this schema)
xdm:acquiredByCampaignKey B2B Source Optional XDM Business Campaign Member Details (this schema)
xdm:b2b object Optional XDM Business Campaign Member Details (this schema)
xdm:firstRespondedDate string Optional XDM Business Campaign Member Details (this schema)
xdm:hasReachedSuccess boolean Optional XDM Business Campaign Member Details (this schema)
xdm:hasResponded boolean Optional XDM Business Campaign Member Details (this schema)
xdm:isDeleted boolean Optional Record Status
xdm:isExhausted boolean Optional XDM Business Campaign Member Details (this schema)
xdm:lastStatus string Optional XDM Business Campaign Member Details (this schema)
xdm:memberStatus string Optional XDM Business Campaign Member Details (this schema)
xdm:memberStatusReason string Optional XDM Business Campaign Member Details (this schema)
xdm:membershipDate string Optional XDM Business Campaign Member Details (this schema)
xdm:nurtureCadence string Optional XDM Business Campaign Member Details (this schema)
xdm:nurtureTrackName string Optional XDM Business Campaign Member Details (this schema)
xdm:reachedSuccessDate string Optional XDM Business Campaign Member Details (this schema)
xdm:webinarConfirmationUrl string Optional XDM Business Campaign Member Details (this schema)
xdm:webinarRegistrationID string Optional XDM Business Campaign Member Details (this schema)
* any Additional this schema allows additional properties

xdm:acquiredByCampaignID

Acquired By CampaignID

xdm:acquiredByCampaignID

  • is optional
  • type: string
  • defined in this schema

xdm:acquiredByCampaignID Type

string

xdm:acquiredByCampaignKey

Acquired By Campaign Key

Unique composite identifier of the campaign where the person became a member

xdm:acquiredByCampaignKey

  • is optional
  • type: B2B Source
  • defined in this schema

xdm:acquiredByCampaignKey Type

  • B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:b2b

xdm:b2b

  • is optional
  • type: object
  • defined in this schema

xdm:b2b Type

object with following properties:

Property Type Required
xdm:personType string Optional

xdm:personType

Person Type

Use this property to map this campaign to the respective measure, eg. Marketo Measure.

xdm:personType

  • is optional
  • type: string
xdm:personType Type

string

xdm:firstRespondedDate

First Responded Date

Date captured on which response was submitted

xdm:firstRespondedDate

  • is optional
  • type: string
  • defined in this schema

xdm:firstRespondedDate Type

string

xdm:hasReachedSuccess

Has Reached Success

xdm:hasReachedSuccess

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasReachedSuccess Type

boolean

xdm:hasResponded

Has Responded

Record whether the member has responded to the workflow stage

xdm:hasResponded

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasResponded Type

boolean

xdm:isDeleted

Soft Delete Flag

Soft delete flag to indicate if the record is marked for deletion.

xdm:isDeleted

xdm:isDeleted Type

boolean

xdm:isExhausted

isExhausted

xdm:isExhausted

  • is optional
  • type: boolean
  • defined in this schema

xdm:isExhausted Type

boolean

xdm:lastStatus

Last Status

xdm:lastStatus

  • is optional
  • type: string
  • defined in this schema

xdm:lastStatus Type

string

xdm:memberStatus

Campaign Member Status

xdm:memberStatus

  • is optional
  • type: string
  • defined in this schema

xdm:memberStatus Type

string

xdm:memberStatusReason

Campaign Member Status Reason

xdm:memberStatusReason

  • is optional
  • type: string
  • defined in this schema

xdm:memberStatusReason Type

string

xdm:membershipDate

Membership Date

xdm:membershipDate

  • is optional
  • type: string
  • defined in this schema

xdm:membershipDate Type

string

xdm:nurtureCadence

Nurture Cadence

xdm:nurtureCadence

  • is optional
  • type: string
  • defined in this schema

xdm:nurtureCadence Type

string

xdm:nurtureTrackName

Nurture Track Name

xdm:nurtureTrackName

  • is optional
  • type: string
  • defined in this schema

xdm:nurtureTrackName Type

string

xdm:reachedSuccessDate

Reached Success Date

xdm:reachedSuccessDate

  • is optional
  • type: string
  • defined in this schema

xdm:reachedSuccessDate Type

string

xdm:webinarConfirmationUrl

Webinar Confirmation Url

xdm:webinarConfirmationUrl

  • is optional
  • type: string
  • defined in this schema

xdm:webinarConfirmationUrl Type

string

xdm:webinarRegistrationID

Webinar Registration ID

xdm:webinarRegistrationID

  • is optional
  • type: string
  • defined in this schema

xdm:webinarRegistrationID Type

string