Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP
  • Data browser
        • Connect to an external API
        • Request attributes for audience export
        • Copy a connection to another tenant
    • Batch uploads
    • Copying entities between tenants
  • Glossary
  1. Connections
  1. Sitecore CDP
  2. Developer center
  3. Connections
  4. Request attributes for audience export

Request attributes for audience export

If you plan to use a Sitecore CDP connection to send the output of the audience export to third-party systems, we recommend you use the following standard audience export notification attributes when creating the connection:

{
  "apiUrl": "${apiUrl}",
  "audienceExportName": "${name}",
  "clientKey": "${clientKey}",
  "definitionType": "${definitionType}",
  "executionRef": "${executionRef}",
  "executionType": "${executionType}",
  "friendlyId": "${friendlyId}",
  "segmentName": "${segmentName}",
  "status": "${status}"
}

Attribute

Type

Description

apiUrl

string

The output URL for the audience export job.

audienceExportName

string

The name of the audience export.

clientKey

string

Your organization's unique and public identifier.

definitionType

string enum (uppercase)

Whether the audience export is a full or a delta export.

executionRef

string (UUID)

The reference of the audience export job.

executionType

string enum (uppercase)

Whether the audience export runs instantly or on a schedule.

friendlyId

string

The unique ID of the audience export.

Only lowercase alphanumeric characters and underscores are allowed.

segmentName

string

The name of the segment selected for the audience export.

status

string enum (uppercase)

The status of the audience export job.

If you have suggestions for improving this article, let us know!

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use