newsletter subscribers grid columns

The newsletter subscribers grid columns extension point adds columns to the grid on the Marketing > Communications > Newsletter Subscribers page in the Adobe Commerce Admin. V2 calls a runtimeAction in your App Builder app directly.

Example customization

The following example creates a custom column labeled Subscription source, backed by a get-newsletter-grid-columns runtime action.

adminUi: {
  newsletter: {
    gridColumns: {
      label: 'Newsletter subscriber grid columns',
      description: 'Adds the subscription source to the newsletter subscribers grid',
      runtimeAction: 'newsletter-custom-grid-columns/get-newsletter-grid-columns',
      columns: [
        { id: 'subscription_source', label: 'Subscription source', type: 'string', align: 'left' },
      ],
    },
  },
},

How it works

  1. A merchant opens the newsletter subscribers grid in the Commerce Admin.
  2. Commerce sends a POST request to your runtime action with the grid type and the visible newsletter subscriber IDs: { requestId, gridType: 'newsletter', ids: ['1', '2', ...] }.
  3. Your action looks up the column values for each subscriber ID and returns them.
  4. Commerce renders the returned values in the corresponding columns, alongside the built-in columns.

For IDs your action does not return, Commerce falls back to the default values your action declares. If no default is provided, the cell is left empty.

Parameters

Field
Type
Required
Description
label
string
No
A label describing the set of columns, used when the columns are protected with an access control list (ACL).
description
string
No
A description of the columns, used when the columns are ACL-protected.
runtimeAction
string
Yes
The runtime action that returns column data, in <package>/<action> format from your app.config.yaml runtime manifest. Commerce resolves this to the full deployed action URL at installation time.
columns[].id
string
Yes
The identifier for the column. Referenced in the request sent to your runtime action and in its response.
columns[].label
string
Yes
The label of the column to display.
columns[].type
string
Yes
The data type of the values in the column. Supported values: boolean, date, datetime, float, integer, string. Date and datetime values must be ISO 8601-compliant.
columns[].align
string
Yes
The alignment of the values in the column. One of left, right, center.
columns[].aclProtected
boolean
No
When true, gates the column behind a dedicated Commerce ACL resource scoped to your app. See ACL protection. The default value is false.