取消列表订阅 list-unsubscribe

使用​一键式取消订阅 URL 选项，单击“取消订阅”链接将直接取消订阅用户。

GET 调用如下：

端点：https://platform.adobe.io/journey/imp/consent/decrypt

查询参数：

• params：包含加密后的有效负载
• pid：加密后的轮廓 ID

这两个参数将包含在发送到自定义端点的同意更新事件中。

标头要求：

• x-api-key
• x-gw-ims-org-id
• 授权（用于技术帐户认证的用户令牌）

以下是示例参数和同意响应：

同意响应：

{
    "profileNameSpace": " CRMID ",
    "profileId": "5142733041546020095851529937068211571",
    "emailAddress": "john@google.com",
    "emailNameSpace": "Email",
    "sandboxId": "sandboxId",
    "optOutLevel": "channel",
    "channelType": "email",
    "timestamp": "2024-11-26T14:25:09.316930Z"
    "utm": [
         {
            "utm_source": "AJO",
            "utm_medium": "Email"
        }
    ]
}

使用 Mailto（取消订阅）​选项，单击“取消订阅”链接会向指定的取消订阅地址发送预填电子邮件。

GET 调用如下。

端点：https://platform.adobe.io/journey/imp/consent/decrypt

查询参数：

• emailParams：包含 params（加密负载）和 pid（加密轮廓 ID）参数的字符串。

params 和 pid 参数将包含在发送到自定义端点的同意更新事件中。

标头要求：

• x-api-key
• x-gw-ims-org-id
• 授权（用于技术帐户认证的用户令牌）

以下是示例参数和同意响应：

同意响应：

{
    "profileNameSpace": " CRMID ",
    "profileId": "5142733041546020095851529937068211571",
    "emailAddress": "john@google.com",
    "emailNameSpace": "Email",
    "sandboxId": "sandboxId",
    "optOutLevel": "channel",
    "channelType": "email",
    "timestamp": "2024-11-26T14:25:09.316930Z"
}

使用 Mailto（取消订阅）​选项，单击“取消订阅”链接会向指定的取消订阅地址发送预填电子邮件。

从 2025 年 10 月开始，如果对 Mailto（取消订阅）​端点使用​ 客户托管 ​选项，则可以定义将会附加到同意事件的自定义属性。 在这种情况下，您需要使用下方介绍的查询参数。

GET 调用如下。

端点：https://platform.adobe.io/journey/imp/consent/decrypt

查询参数：

• emailParamsSub：从 Mailto 地址收到的电子邮件主题中提取的字符串。

  • 示例：unsubscribev1.abc

  • 解析值：v1.abc

• emailParamsBody：从 unsubscribev1.xyz 格式的电子邮件正文（如有）提取的字符串。

  • 解析值：v1.xyz

API 示例： https://platform.adobe.io/journey/imp/consent/decrypt?emailParamsSub=v1.abc&emailParamsBody=v1.xyz

emailParamsSub 和 emailParamsBody 参数将包含在发送到自定义端点的同意更新事件中。

标头要求：

• x-api-key
• x-gw-ims-org-id
• 授权（用于技术帐户认证的用户令牌）

同意响应：

{
    "profileNameSpace": " CRMID ",
    "profileId": "5142733041546020095851529937068211571",
    "emailAddress": "john@google.com",
    "emailNameSpace": "Email",
    "sandboxId": "sandboxId",
    "optOutLevel": "channel",
    "channelType": "email",
    "timestamp": "2024-11-26T14:25:09.316930Z"
    "utm": [
        {
            "utm_source": "AJO",
            "utm_medium": "Email"
        }
    ]
}

This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.

For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.

• TL;DR: This page explains how to enable and configure the List-Unsubscribe header so recipients can opt out from their inbox using a Mailto (unsubscribe) address or a one-click unsubscribe URL, including the Adobe managed and Customer managed options and the decrypt API for external consent systems.

Intents:

• Enable the List-Unsubscribe header in an email channel configuration
• Configure the Mailto (unsubscribe) address and the One-click unsubscribe URL options
• Set the Consent level to channel or profile identity
• Manage unsubscribe data externally with the Customer managed option
• Configure the decrypt API to retrieve encrypted consent parameters for custom endpoints
• Append custom attributes to unsubscribe endpoints using URL tracking parameters

Glossary:

• List-Unsubscribe header: An email header that lets recipients opt out directly from their inbox; enabled via the Enable List-Unsubscribe option, on by default (product-specific)
• Mailto (unsubscribe): The destination address where unsubscribe requests are routed for auto-processing, based on the selected subdomain (product-specific)
• One-click unsubscribe URL: The one-click opt-out URL generated for the List unsubscribe header, based on the selected subdomain (product-specific)
• Consent level: A setting, specific to the channel or to the profile identity, that determines whether consent updates at channel level or ID level (product-specific)
• Adobe managed / Customer managed: Options defining whether consent data is managed within the Adobe system, or in an external system with no automatic synchronization to Adobe (product-specific)
• decrypt API: An API on Adobe Developer used by an external consent system to decrypt the encrypted parameters sent by Adobe to custom endpoints (product-specific)

Guardrails:

• The Enable List-Unsubscribe option is enabled by default; its two options (Mailto and One-click unsubscribe URL) are enabled by default unless one or both are unchecked.
• To display the one-click unsubscribe URL in the email header, the recipients’ email client must support this feature.
• The One-click Unsubscribe URL must use the POST request method.
• With the Customer managed option, Adobe does not store any unsubscribe or consent data; there is no auto synchronization, and the organization must initiate any data transfer to push consent data back into Journey Optimizer.
• Appending custom attributes to endpoints is available in Limited Availability (contact your Adobe representative to gain access).
• Starting October 2025, Customer managed Mailto (unsubscribe) with custom attributes requires the new emailParamsSub and emailParamsBody query parameters instead of emailParams.
• Journey Optimizer does not append a specific tag to unsubscribe events triggered by the List unsubscribe feature; differentiating these clicks requires custom external tagging or an external landing page.
• The order of UTM parameters appended to the URL is random and cannot be controlled; systems requiring a specific order must parse and reorder them.
• By default the consent field value is empty and treated as consent to receive communications.

Terminology:

• Canonical name: List-Unsubscribe header — Acronym: n/a — variants: List unsubscribe, one-click list unsubscribe URL
• Synonyms: “One-click unsubscribe URL” = “One-click opt-out URL” (when a one-click opt-out link inserted in the email body is picked up as the header value)
• Do not confuse: “Mailto (unsubscribe)” (routes an unsubscribe request to an address for auto-processing) ≠ “One-click unsubscribe URL” (directly opts the recipient out on click)
• Do not confuse: “Adobe managed” (consent data managed within the Adobe system) ≠ “Customer managed” (consent data managed in an external system, no auto synchronization)

FAQ:

• Q: Is the List-Unsubscribe header on by default? — Yes; the Enable List-Unsubscribe option is enabled by default, and both the Mailto and One-click unsubscribe URL methods are enabled by default unless unchecked.
• Q: Which methods should I enable? — Adobe recommends enabling both Mailto (unsubscribe) and One-click unsubscribe URL, since not all email clients support the HTTP method; also add a one-click opt-out or unsubscribe link in the email body.
• Q: What request method must a custom one-click unsubscribe URL use? — It must be a POST URL.
• Q: What happens to consent data with the Customer managed option? — Adobe stores no unsubscribe or consent data; there is no automatic synchronization, and you must initiate any transfer of consent data back into Journey Optimizer.
• Q: Can I tell List unsubscribe clicks apart from other unsubscribe actions? — Not by a built-in tag; Journey Optimizer does not append a specific tag, so you must implement custom tagging externally or use an external landing page for tracking.