Export promotions

For the general submit-and-poll flow, see Exports overview.

Request

You can pass:

A UTC datetime — only promotions modified after this date will be included.
externalId of a promotion segment — required if you didn't pick one in the operation step settings.

Promotions with the Draft status are never included.

Response format

{
  "promotions": [
    {
      "ids": {
        "externalId": "<Promotion external ID>"
      },
      "name": "<Promotion name>",
      "description": "<Promotion description>",
      "startDateTimeUtc": "<Promotion start datetime>",
      "endDateTimeUtc": "<Promotion end datetime>",
      "state": "Paused/Archived/Execution",
      "customFields": {
        "customField1": "<Field value>"
      },
      "products": {
        "includedSegments": [{
          "segmentation": {
            "ids": {
              "externalId": "<Segmentation external ID>"
            }
          },
          "segment": {
            "ids": {
              "externalId": "<Segment external ID>"
            }
          }
        }],
        "excludedSegments": [{
          "segmentation": {
            "ids": {
              "externalId": "<Segmentation external ID>"
            }
          },
          "segment": {
            "ids": {
              "externalId": "<Segment external ID>"
            }
          }
        }]
      },
      "areas": [
        {
          "ids": {
            "externalId": "<Area external ID>"
          }
        },
        {
          "ids": {
            "externalId": "<Area external ID>"
          }
        }
      ],
      "pointsOfContact": [
        {
          "ids": {
            "externalId": "<Touchpoint external ID>"
          }
        },
        {
          "ids": {
            "externalId": "<Touchpoint external ID>"
          }
        }
      ]
    }
  ]
}

Limitation when exporting touchpoints by segment

When a promotion picks its touchpoints through a segmentation, pointsOfContact only returns the points that belong to one of these top-level system channels:

Offline
Sites
MobileApp

Touchpoints nested under any other channel type (for example, custom categories) won't appear in the export.

📘
Workaround
Move the affected category or individual touchpoints under one of the supported system channels — for example, into Offline.
How to do it:

In your project's UI, go to Settings → Customers and actions → Touchpoints, select or filter the touchpoints you want to change, then click Actions → Set channels.

Via API import or import through the UI.

The limitation doesn't apply to promotions where touchpoints are picked manually from the tree. In that case, every selected point is returned regardless of which channel it lives in.

Updated about 2 months ago