Skip to content

Latest commit

 

History

History
699 lines (451 loc) · 21.2 KB

optinout.schema.md

File metadata and controls

699 lines (451 loc) · 21.2 KB
Raw

OptInOut Schema

https://ns.adobe.com/xdm/context/optinout

Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/optinout.schema.json

Schema Hierarchy

OptInOut Example

{
  "https://ns.adobe.com/xdm/channels/email": "pending",
  "https://ns.adobe.com/xdm/channels/phone": "out",
  "https://ns.adobe.com/xdm/channels/sms": "in",
  "https://ns.adobe.com/xdm/channels/fax": "not_provided",
  "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided",
  "https://ns.adobe.com/xdm/channels/apns": "not_provided",
  "xdm:globalOptout": false,
  "xdm:optOutDetails": {
    "xdm:email": {
      "xdm:optOutReason": "Reason here",
      "xdm:optOutDate": "2018-01-20T15:52:25+00:00"
    },
    "xdm:phone": {
      "xdm:optOutReason": "Reason here",
      "xdm:optOutDate": "2018-01-20T15:52:25+00:00"
    }
  }
}

OptInOut Properties

Property Type Required Default Defined by
https://ns.adobe.com/xdm/channels/adm enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/agency enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/apns enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/application enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/baidu enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/channel enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/direct-mail enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/email enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/facebook-feed enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/fax enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/gcm enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/line enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/mobile-app enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/mpns enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/phone enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/sms enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/twitter-feed enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/web enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/webpage enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/wechat enum Optional "not_provided" OptInOut (this schema)
https://ns.adobe.com/xdm/channels/wns enum Optional "not_provided" OptInOut (this schema)
xdm:globalOptout boolean Optional false OptInOut (this schema)
xdm:optOutDetails object Optional OptInOut (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/xdm/channels/adm

Amazon Device Messaging

Amazon Device Messaging (ADM) channel OptInOut.

https://ns.adobe.com/xdm/channels/adm

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/adm Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/agency

Agency

External agency channel OptInOut.

https://ns.adobe.com/xdm/channels/agency

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/agency Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/apns

Apple Push Notification Service

Apple Push Notification Service (APNS) channel OptInOut.

https://ns.adobe.com/xdm/channels/apns

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/apns Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/application

Application

Application channel OptInOut.

https://ns.adobe.com/xdm/channels/application

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/application Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/baidu

Baidu Cloud Push Service

Baidu Cloud Push Service channel OptInOut.

https://ns.adobe.com/xdm/channels/baidu

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/baidu Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/channel

Experience Channel

Experience channel OptInOut.

https://ns.adobe.com/xdm/channels/channel

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/channel Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/direct-mail

Direct mail

Mail delivered by a postal service channel OptInOut.

https://ns.adobe.com/xdm/channels/direct-mail

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/direct-mail Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/email

Email

Email messages, delivered via SMTP to list subscribers channel OptInOut.

https://ns.adobe.com/xdm/channels/email

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/email Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/facebook-feed

Facebook news feed

The Facebook news feed channel OptInOut.

https://ns.adobe.com/xdm/channels/facebook-feed

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/facebook-feed Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/fax

Fax

Fax or telefacsimile channel OptInOut.

https://ns.adobe.com/xdm/channels/fax

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/fax Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/gcm

Google Cloud Messaging

Google Cloud Messaging (GCM) channel OptInOut.

https://ns.adobe.com/xdm/channels/gcm

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/gcm Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/line

Line Platform Notification

Line Platform Notification (LINE) channel OptInOut.

https://ns.adobe.com/xdm/channels/line

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/line Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/mobile-app

Web

Native mobile applications that are installed through an app store channel OptInOut.

https://ns.adobe.com/xdm/channels/mobile-app

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/mobile-app Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/mpns

Microsoft Push Notification Service

Microsoft Push Notification Service (MPNS) channel OptInOut.

https://ns.adobe.com/xdm/channels/mpns

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/mpns Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/phone

Phone

The telephone channel OptInOut.

https://ns.adobe.com/xdm/channels/phone

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/phone Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/sms

SMS

Short Message Service delivered to a mobile phone channel OptInOut.

https://ns.adobe.com/xdm/channels/sms

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/sms Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/twitter-feed

Twitter feed

Twitter feed channel OptInOut.

https://ns.adobe.com/xdm/channels/twitter-feed

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/twitter-feed Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/web

Web

World Wide Web and mobile web channel OptInOut.

https://ns.adobe.com/xdm/channels/web

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/web Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/webpage

Web Page

Web Page channel OptInOut.

https://ns.adobe.com/xdm/channels/webpage

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/webpage Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/wechat

WeChat

WeChat Platform Notification channel OptInOut.

https://ns.adobe.com/xdm/channels/wechat

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/wechat Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

https://ns.adobe.com/xdm/channels/wns

Windows Push Notification Service

Windows Push Notification Service (WNS) channel OptInOut.

https://ns.adobe.com/xdm/channels/wns

  • is optional
  • type: enum
  • default: "not_provided"
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/xdm/channels/wns Known Values

Value Description
not_provided Not provided
pending Pending verification
in Opt-in: the user explicitly consents to receiving messages.
out Opt-out: the user declines to receive any messages on this channel.

xdm:globalOptout

Global Opt-out

Do not contact this profile on any outbound channel.

xdm:globalOptout

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

xdm:globalOptout Type

boolean

xdm:optOutDetails

xdm:optOutDetails

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

xdm:optOutDetails Type

object with following properties:

Property Type Required
xdm:direct-mail Optional
xdm:email Optional
xdm:fax Optional
xdm:phone Optional

xdm:direct-mail

Additional Details for Direct-Mail Opt Out

Additional details for direct-mail opt out like reason, date.

xdm:direct-mail

  • is optional
  • type: reference
xdm:direct-mail Type
  • – https://ns.adobe.com/xdm/common/optinout-additional-details

xdm:email

Additional Details for Email Opt Out

Additional Details for Email Opt Out like reason, date.

xdm:email

  • is optional
  • type: reference
xdm:email Type
  • – https://ns.adobe.com/xdm/common/optinout-additional-details

xdm:fax

Additional Details for Fax Opt Out

Additional details for fax opt out like reason, date.

xdm:fax

  • is optional
  • type: reference
xdm:fax Type
  • – https://ns.adobe.com/xdm/common/optinout-additional-details

xdm:phone

Additional Details for Phone Opt Out

Additional details for phone opt out like reason, date.

xdm:phone

  • is optional
  • type: reference
xdm:phone Type
  • – https://ns.adobe.com/xdm/common/optinout-additional-details