/segment-audiences | Type: Application | PCID required: Yes
Tools
segment_audiences_add_activation_to_audience
Add Activation to Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
connectionId | string | Yes | — | Connection Id |
activationName | string | Yes | — | Activation name. For Warehouse Destinations, this is used as the table name. |
activationType | string | Yes | — | Determines when an event is sent to the Destination. Possible values: Audience Entered: Sends an event when a profile or entity enters the audience. Audience Exited: Sends an event when a profile or entity exits the audience. Audience Membership Changed: Sends an event for both entries and exits. This does not apply to entities. Note that events are sent for the profile, unless the audience is a Linked Audience. In that case, events are sent for the target entity defined for that audience. |
destinationMapping | object | No | — | Defines the specific action and data mapping for the Destination. Only applicable for Action Destinations. Action id: Specifies which action to perform on the Destination (for example: add contact, update list). Settings/Mapping: Defines how event data (including personalization traits) populates specific fields in the Destination. Use the List Supported Destinations from Audience endpoint to find available action ids and the specific Destination fields you can map. |
displayName | string | No | — | Optional human-readable label for the activation. Only supported for Warehouse Destinations. When omitted, the activationName is used as the label. |
enabled | boolean | No | — | Determines whether an activation is enabled. |
performResync | boolean | Yes | — | Determines whether to perform a full resync upon creation. If true, the entire audience is resent to the Destination from scratch. If false, only future changes will be synced. |
personalization | object | Yes | — | The data points used to enrich the event. Defines which profile traits and/or entity properties are included in the event sent to the Destination. For Action Destinations, any traits or properties specified here must also be included in the destinationMapping to define which Destination fields should be populated. |
segment_audiences_add_audience_schedule_to_audience
Add Audience Schedule to Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
config | object | Yes | — | Configuration for PERIODIC or SPECIFIC_DAYS strategies. |
strategy | string | Yes | — | Strategy of the audience schedule (periodic or specific days). |
segment_audiences_add_destination_to_audience
Add Destination to Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
connectionSettings | object | No | — | The settings that a Destination requires to create audiences on a third-party platform. These settings are Destination-specific. Use the List Supported Destinations from Audience endpoint to find the required connection settings. |
destination | object | Yes | — | The Destination. |
idSyncConfiguration | object[] | No | — | Identifier sync configuration. Defines which external ids to sync and their selection strategies. Maximum 5 items allowed. If omitted, the default will be last email and last user_id, or all email and all user_id depending on the Destination. |
segment_audiences_batch_query_messaging_subscriptions_for_space
Batch Query Messaging Subscriptions for Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
subscriptions | object[] | Yes | — | A list of subscriptions to retrieve subscription status. |
segment_audiences_create_audience
Create Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceType | string | Yes | — | Denotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED. |
definition | object | Yes | — | Query language definition. |
description | string | No | — | Description of the audience. |
enabled | boolean | No | — | Determines whether a computation is enabled. |
name | string | Yes | — | Name of the audience. |
options | object | No | — | Represents the options of Including Anonymous users and Historical Data. |
segment_audiences_create_audience_preview
Create Audience Preview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceType | string | Yes | — | Denotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED. |
definition | object | Yes | — | Query language definition. |
options | object | No | — | Options which should be applied when segmenting audiences. |
segment_audiences_create_computed_trait
Create Computed Trait Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
definition | object | Yes | — | Represents the Compute Query Language definition of the computation and type of computation. |
description | string | No | — | The description of the computation. |
enabled | boolean | No | — | Determines whether a computation is enabled. |
name | string | Yes | — | The name of the computation. |
options | object | No | — | Options which should be applied when aggregating computed traits. |
segment_audiences_create_download
Create Download Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collectionId | string | Yes | — | The collection’s unique id. |
hour | string | Yes | — | The ISO8601 formatted timestamp corresponding to a specific hour and day to retrieve data for. E.g.: 2025-05-07T23:00:00Z Objects are bucketed by hour and a month of data is retained. |
segment_audiences_create_filter_for_space
Create Filter for Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description of the filter. |
drop | boolean | No | — | Whether the event is dropped. |
enabled | boolean | No | — | Whether the filter is enabled. |
if | string | Yes | — | The “if” statement for a filter. |
integrationId | string | Yes | — | The Space id to filter on. |
name | string | Yes | — | The name of the filter. |
segment_audiences_delete_filter_by_id
Delete Filter By Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
segment_audiences_force_execute_audience_run
Force Execute Audience Run Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
segment_audiences_get_activation_from_audience
Get Activation from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
id | string | Yes | — | The id value |
segment_audiences_get_audience
Get Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
include | string | No | — | Additional resource to include, support schedules only. This parameter exists in alpha. |
segment_audiences_get_audience_preview
Get Audience Preview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
segment_audiences_get_audience_schedule_from_space_and_audience
Get Audience Schedule from Space And Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
scheduleId | string | Yes | — | Schedule Id |
segment_audiences_get_computed_trait
Get Computed Trait Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
segment_audiences_get_filter_by_id
Get Filter By Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
segment_audiences_get_space
Get Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
segment_audiences_list_activations_from_audience
List Activations from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
pagination | object | No | — | Optional pagination. This parameter exists in alpha. |
segment_audiences_list_audience_consumers_from_space_and_audience
List Audience Consumers from Space And Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
pagination | object | No | — | Information about the pagination of this response. See pagination for more info. This parameter exists in alpha. |
search | object | No | — | Optional search criteria This parameter exists in alpha. |
sort | object | No | — | Optional sort criteria This parameter exists in alpha. |
segment_audiences_list_audience_schedules_from_space_and_audience
List Audience Schedules from Space And Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
segment_audiences_list_audiences
List Audiences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
search | object | No | — | Optional search criteria This parameter exists in alpha. |
pagination | object | No | — | Information about the pagination of this response. See pagination for more info. This parameter exists in alpha. |
include | string | No | — | Additional resource to include, support schedules only. This parameter exists in alpha. |
segment_audiences_list_computed_traits
List Computed Traits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
pagination | object | No | — | Information about the pagination of this response. See pagination for more info. This parameter exists in alpha. |
segment_audiences_list_destinations_from_audience
List Destinations from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
pagination | object | No | — | Optional pagination. This parameter exists in alpha. |
segment_audiences_list_filters_for_space
List Filters for Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integrationId | string | Yes | — | The Space Id for which to fetch filters This parameter exists in beta. |
pagination | object | No | — | Pagination parameters. This parameter exists in beta. |
segment_audiences_list_spaces
List Spaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Pagination params This parameter exists in alpha. |
segment_audiences_list_supported_destinations_from_audience
List Supported Destinations from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceType | string | Yes | — | Audience Type |
slug | string | No | — | Optional destination slug to filter results. This parameter exists in alpha. |
actionId | string | No | — | Optional destination action id to filter results. This parameter exists in alpha. |
segment_audiences_remove_activation_from_audience
Remove Activation from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
id | string | Yes | — | The id value |
segment_audiences_remove_audience_from_space
Remove Audience from Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
segment_audiences_remove_audience_schedule_from_audience
Remove Audience Schedule from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
scheduleId | string | Yes | — | Schedule Id |
segment_audiences_remove_computed_trait_from_space
Remove Computed Trait from Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
segment_audiences_remove_destination_from_audience
Remove Destination from Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
destinationId | string | Yes | — | Destination Id |
segment_audiences_replace_messaging_subscriptions_in_spaces
Replace Messaging Subscriptions in Spaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
subscriptions | object[] | Yes | — | An array of subscriptions. |
segment_audiences_update_activation_for_audience
Update Activation for Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
id | string | Yes | — | The id value |
activationName | string | No | — | Activation name. For Warehouse Destinations, this is used as the table name. |
destinationMapping | object | No | — | Defines the specific action and data mapping for the Destination. Only applicable for Action Destinations. Action id: Specifies which action to perform on the Destination (for example: add contact, update list). Settings/Mapping: Defines how event data (including personalization traits) populates specific fields in the Destination. Use the List Supported Destinations from Audience endpoint to find available action ids and the specific Destination fields you can map. |
displayName | string | No | — | Optional human-readable label for the activation. Only supported for Warehouse Destinations. Send null to clear. When omitted, the activationName is used as the label. |
enabled | boolean | No | — | Determines whether an activation is enabled. |
performResync | boolean | No | — | Determines whether to perform a full resync after the update. If true, the entire audience is resent to the Destination using the updated configuration. If false, the update applies only to future syncs. |
personalization | object | No | — | The data points used to enrich the event. Defines which profile traits and/or entity properties are included in the event sent to the Destination. For Action Destinations, any traits or properties specified here must also be included in the destinationMapping to define which Destination fields should be populated. |
segment_audiences_update_audience_for_space
Update Audience for Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
definition | object | No | — | Represents the Compute Query Language definition of the computation and type of computation. |
description | string | No | — | The description of the computation. |
enabled | boolean | No | — | Enabled/disabled status for the audience. |
name | string | No | — | The name of the computation. |
options | object | No | — | Represents the options of Including Anonymous users and Historical Data. |
segment_audiences_update_audience_schedule_for_audience
Update Audience Schedule for Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
scheduleId | string | Yes | — | Schedule Id |
config | object | No | — | Configuration for PERIODIC or SPECIFIC_DAYS strategies. |
strategy | string | No | — | Strategy of the audience schedule (periodic or specific days). |
segment_audiences_update_computed_trait_for_space
Update Computed Trait for Space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
id | string | Yes | — | The id value |
definition | object | No | — | Query language definition and type. Note: The definition for a Computed Trait updated using the API is not editable through the Segment App. |
description | string | No | — | The description of the computation. |
enabled | boolean | No | — | Enabled/disabled status for the computed trait. |
name | string | No | — | The name of the computation. |
segment_audiences_update_destination_for_audience
Update Destination for Audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | Space Id |
audienceId | string | Yes | — | Audience Id |
destinationId | string | Yes | — | Destination Id |
connectionSettings | object | No | — | The settings that a Destination requires to create audiences on a third-party platform. |
idSyncConfiguration | object[] | No | — | Identifier sync configuration - array of external IDs to sync with their strategies. Maximum 5 items allowed. |
segment_audiences_update_filter_by_id
Update Filter By Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
description | string | No | — | The description of the filter. |
drop | boolean | No | — | Whether the event is dropped. |
enabled | boolean | No | — | Whether the filter is enabled. |
if | string | No | — | The “if” statement for a filter. |
integrationId | string | No | — | The Integration id of the resource. |
name | string | No | — | The name of the filter. |

