subscriptionId: Identifier for the communication subscription
Pattern: /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Min Length: 1
Max Length: 255
property
channels:
property
consentStatus: Subscription status information across different channels. This field is only included in the response when the 'expand' parameter contains "consentStatus". For privacy and performance reasons, status is not returned by default.
property
title: The localized title of the subscription for shopper displays
Min Length: 1
Max Length: 255
property
subtitle: The localized subtitle of the subscription for shopper displays, may contain HTML markup
Min Length: 1
Max Length: 2000
property
tags:
property
consentType: Type of consent subscription
property
consentRequired: Whether this subscription is mandatory for the user
property
defaultStatus: Default consent status for this subscription
subscriptionId: Identifier for the communication subscription
Pattern: /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Min Length: 1
Max Length: 255
property
contactPointValue: The customer's contact point value, polymorphic based on the channel type as below: - sms - Subject's phone number in E.164 format, ex: +1 424 535 3546 - email - Subject's email address in RFC 5321 & RFC 5322 format, ex: jack.sparrow@salesforce.com
subscriptionId: Identifier for the communication subscription
Pattern: /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Min Length: 1
Max Length: 255
property
channel:
property
contactPointValue: The customer's contact point value, polymorphic based on the channel type as below: - sms - Subject's phone number in E.164 format, ex: +1 424 535 3546 - email - Subject's email address in RFC 5321 & RFC 5322 format, ex: jack.sparrow@salesforce.com
Min Length: 3
Max Length: 320
property
status:
property
success: Whether the subscription update was successful
property
error: Error details (present when success is false)
subscriptionId: Identifier for the communication subscription
Pattern: /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Min Length: 1
Max Length: 255
property
channel:
property
contactPointValue: The customer's contact point value, polymorphic based on the channel type as below: - sms - Subject's phone number in E.164 format, ex: +1 424 535 3546 - email - Subject's email address in RFC 5321 & RFC 5322 format, ex: jack.sparrow@salesforce.com
title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization
Max Length: 256
property
type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.
Max Length: 2048
property
detail: A human-readable explanation specific to this occurrence of the problem.
property
instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.
contactPointValue: The customer's contact point value, polymorphic based on the channel type as below: - sms - Subject's phone number in E.164 format, ex: +1 424 535 3546 - email - Subject's email address in RFC 5321 & RFC 5322 format, ex: jack.sparrow@salesforce.com
The consent status of the subscription as supplied or recorded by this system