Skip to content

Latest commit

 

History

History
355 lines (232 loc) · 12.7 KB

optinout.schema.md

File metadata and controls

355 lines (232 loc) · 12.7 KB

OptInOut Schema

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

Describes a users' communication preferences by channel. For each channel individually, which is a property of this object, a user's preference (opt-in, opt-out, 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 Experimental No Forbidden Permitted context/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
}

OptInOut Properties

Property Type Required Defined by
https://ns.adobe.com/xdm/channels/adm enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/apns enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/baidu enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/direct-mail enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/email enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/fax enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/gcm enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/line enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/mpns enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/phone enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/sms enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/wechat enum Optional OptInOut (this schema)
https://ns.adobe.com/xdm/channels/wns enum Optional OptInOut (this schema)
xdm:globalOptout boolean Optional OptInOut (this schema)
* any Additional this schema allows additional properties

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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/apns

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/baidu

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/direct-mail

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/fax

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/mpns

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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/wechat

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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

Communication preference for the outbound channel identified through its URL by the name of the property.

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

  • is optional
  • type: enum
  • 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
  • defined in this schema

xdm:globalOptout Type

boolean