Segments API

Create a configuration for a segment

Changed on May 12, 2025

Creates a configuration for a segment

post/segments

Request

Base URL: https://cja.adobe.io
URL: https://cja.adobe.io/segments
Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Query parameters

localestring

Locale

expansionstring[]

Comma-delimited list of additional segment metadata fields to include on response.

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request body

namestring

descriptionstring

modifiedstring date-time

report_suitestring

modifiedByIdstring

definitionobject

compatibilityobject

createDatestring date-time

createdBystring

disabledboolean

internalboolean

organizationstring

templateboolean

recentRecordedAccessstring date-time

performanceScorestring

performanceScoreWeightVersionstring

idstring

definitionLastModifiedstring date-time

dataIdstring

isDeletedboolean

dataNamestring

tagsobject[]

sharesobject[]

approvedboolean

favoriteboolean

usageSummaryobject

Response

Successful operation