j1.1.4
API Overview
Use the Consents Admin API to manage customer consent subscription preferences for marketing communications across multiple channels. This API provides complete CRUD (Create, Read, Update, Delete) operations for subscription management, with support for rich text markup in subscription titles and subtitles.
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
You must include one of the following OAuth scopes in the client ID used to generate the token:
sfcc.consents: Required for reading subscription data (GET operations)sfcc.consents.rw: Required for creating, updating, and deleting subscription data (POST, PUT, PATCH, DELETE operations)
For a full list of permissions, see the Authorization Scopes Catalog.
For detailed setup instructions, see the Authorization for Admin APIs guide.
Data Model
Subscriptions
Subscriptions represent a customer's consent to receive specific types of marketing communications. Each subscription includes:
- Identifier:
subscriptionId: Descriptive identifier following kebab-case format (1-255 characters, pattern:^[a-z0-9]+(?:-[a-z0-9]+)*$)siteId: Commerce Cloud site identifier for multi-site organizations
- Display Information: Rich text content with localization and HTML markup support
title: Localized subscription titles with markup support (required for creation)subtitle: Optional localized subscription subtitles with markup support
- Consent Configuration:
channels: Array of supported communication methods (required, 1-10 items)tags: Configurable filter tags for subscription categorization (0-10 items, defaults to empty array)consentType: Type classification (marketingorlegal, defaults tomarketing)consentRequired: Whether the subscription is mandatory (defaults tofalse)defaultStatus: Default consent state (opt_inoropt_out, defaults toopt_out)enabled: Whether the subscription is currently active (defaults totrue) - defined as reusableEnabledschema component
- System Integration:
umaSubscriptionId: Salesforce UMA CommSubscription object ID (15-18 characters)
Channels
Channels define the communication methods available for a subscription:
email: Email communicationssms: SMS/text messageswhatsapp: WhatsApp
Tags
Tags can be used to filter the subscriptions for various uses. Provided tags include:
homepage_banner: Main website homepageregistration: Customer registration processcheckout: During the checkout processuser_profile: User profile management area
Let us know so we can improve!