Sign in
latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Parent Segment Configurations

Update parent segment configuration

Update the specified parent segment configuration by its identifier.

Important: Update Behavior and the master Field

This endpoint supports two different update modes depending on whether the master field is included in the request body:

  1. Partial Update (without master field): When the master field is omitted, only the scalar fields (e.g., name, description, scheduleType) in the request body are updated. The attributes, behaviors, and audienceFilters collections are left untouched, even if they are omitted or set to null or [] in the request.

  2. Full Replacement (with master field): When the master field is included in the request body, the endpoint performs a full replacement of attributes, behaviors, and audienceFilters. All existing entries in these collections are deleted and replaced with exactly what is provided in the request:

    • If attributes, behaviors, or audienceFilters are omitted, set to null, or set to [], those collections will be cleared (all existing entries deleted).
    • Only the items explicitly included in the request body will exist after the update.
    • This is a destructive operation that cannot be undone.

Recommendations:

  • For partial updates of scalar fields only: omit the master field from the request body.
  • For full replacement: include the master field and provide complete definitions for attributes, behaviors, and audienceFilters to avoid unintended data loss.
put/audiences/{audienceId}

Path parameters

audienceIdinteger required

ID of Master Segment Config that needs to be updated

Request body

idstring integer
namestring required
descriptionstring
scheduleType'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly'
scheduleOptionstring nullable
timezonestring
matrixUpdatedAtstring datetime nullable
workflowHiveOnlyboolean

Whether the workflow mainly use Hive or not. Default is false

hiveEngineVersion'0.13' | 'cdpaudience'

Hive engine version used in audience workflows

hivePoolNamestring nullable
prestoPoolNamestring nullable
allowActivationBehaviorboolean nullable
maxActivationBehaviorRowinteger nullable

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean nullable

llmEnabled indicates whether customer has enabled llm (true or false).

llmState'enabling' | 'enabled' | 'disabling' | 'disabled'

llmState indicates more detailed state including updating.

populationinteger nullable

the population of the audience

enrichmentWordTaggingEnabledboolean
enrichmentIpEnabledboolean
enrichmentTdJsSdkEnabledboolean
createdAtstring date-time
updatedAtstring date-time

Example request

{
  "scheduleType": "daily",
  "scheduleOption": "00:00",
  "timezone": "UTC",
  "behaviors": [
    {
      "scheduleType": "daily"
    }
  ],
  "audienceFilters": [
    {
      "columnName": "Country",
      "rightValues": [
        "Japan"
      ]
    }
  ]
}