Skip to main content
Server path: /segment-audiences | Type: Application | PCID required: Yes

Tools

ToolDescription
segment_audiences_add_activation_to_audienceAdd Activation to Audience
segment_audiences_add_audience_schedule_to_audienceAdd Audience Schedule to Audience
segment_audiences_add_destination_to_audienceAdd Destination to Audience
segment_audiences_batch_query_messaging_subscriptions_for_spaceBatch Query Messaging Subscriptions for Space
segment_audiences_create_audienceCreate Audience
segment_audiences_create_audience_previewCreate Audience Preview
segment_audiences_create_computed_traitCreate Computed Trait
segment_audiences_create_downloadCreate Download
segment_audiences_create_filter_for_spaceCreate Filter for Space
segment_audiences_delete_filter_by_idDelete Filter By Id
segment_audiences_force_execute_audience_runForce Execute Audience Run
segment_audiences_get_activation_from_audienceGet Activation from Audience
segment_audiences_get_audienceGet Audience
segment_audiences_get_audience_previewGet Audience Preview
segment_audiences_get_audience_schedule_from_space_and_audienceGet Audience Schedule from Space And Audience
segment_audiences_get_computed_traitGet Computed Trait
segment_audiences_get_filter_by_idGet Filter By Id
segment_audiences_get_spaceGet Space
segment_audiences_list_activations_from_audienceList Activations from Audience
segment_audiences_list_audience_consumers_from_space_and_audienceList Audience Consumers from Space And Audience
segment_audiences_list_audience_schedules_from_space_and_audienceList Audience Schedules from Space And Audience
segment_audiences_list_audiencesList Audiences
segment_audiences_list_computed_traitsList Computed Traits
segment_audiences_list_destinations_from_audienceList Destinations from Audience
segment_audiences_list_filters_for_spaceList Filters for Space
segment_audiences_list_spacesList Spaces
segment_audiences_list_supported_destinations_from_audienceList Supported Destinations from Audience
segment_audiences_remove_activation_from_audienceRemove Activation from Audience
segment_audiences_remove_audience_from_spaceRemove Audience from Space
segment_audiences_remove_audience_schedule_from_audienceRemove Audience Schedule from Audience
segment_audiences_remove_computed_trait_from_spaceRemove Computed Trait from Space
segment_audiences_remove_destination_from_audienceRemove Destination from Audience
segment_audiences_replace_messaging_subscriptions_in_spacesReplace Messaging Subscriptions in Spaces
segment_audiences_update_activation_for_audienceUpdate Activation for Audience
segment_audiences_update_audience_for_spaceUpdate Audience for Space
segment_audiences_update_audience_schedule_for_audienceUpdate Audience Schedule for Audience
segment_audiences_update_computed_trait_for_spaceUpdate Computed Trait for Space
segment_audiences_update_destination_for_audienceUpdate Destination for Audience
segment_audiences_update_filter_by_idUpdate Filter By Id

segment_audiences_add_activation_to_audience

Add Activation to Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
connectionIdstringYesConnection Id
activationNamestringYesActivation name. For Warehouse Destinations, this is used as the table name.
activationTypestringYesDetermines 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.
destinationMappingobjectNoDefines 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.
displayNamestringNoOptional human-readable label for the activation. Only supported for Warehouse Destinations. When omitted, the activationName is used as the label.
enabledbooleanNoDetermines whether an activation is enabled.
performResyncbooleanYesDetermines 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.
personalizationobjectYesThe 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:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
configobjectYesConfiguration for PERIODIC or SPECIFIC_DAYS strategies.
strategystringYesStrategy of the audience schedule (periodic or specific days).

segment_audiences_add_destination_to_audience

Add Destination to Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
connectionSettingsobjectNoThe 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.
destinationobjectYesThe Destination.
idSyncConfigurationobject[]NoIdentifier 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:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
subscriptionsobject[]YesA list of subscriptions to retrieve subscription status.

segment_audiences_create_audience

Create Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceTypestringYesDenotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED.
definitionobjectYesQuery language definition.
descriptionstringNoDescription of the audience.
enabledbooleanNoDetermines whether a computation is enabled.
namestringYesName of the audience.
optionsobjectNoRepresents the options of Including Anonymous users and Historical Data.

segment_audiences_create_audience_preview

Create Audience Preview Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceTypestringYesDenotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED.
definitionobjectYesQuery language definition.
optionsobjectNoOptions which should be applied when segmenting audiences.

segment_audiences_create_computed_trait

Create Computed Trait Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
definitionobjectYesRepresents the Compute Query Language definition of the computation and type of computation.
descriptionstringNoThe description of the computation.
enabledbooleanNoDetermines whether a computation is enabled.
namestringYesThe name of the computation.
optionsobjectNoOptions which should be applied when aggregating computed traits.

segment_audiences_create_download

Create Download Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesThe collection’s unique id.
hourstringYesThe 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:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description of the filter.
dropbooleanNoWhether the event is dropped.
enabledbooleanNoWhether the filter is enabled.
ifstringYesThe “if” statement for a filter.
integrationIdstringYesThe Space id to filter on.
namestringYesThe name of the filter.

segment_audiences_delete_filter_by_id

Delete Filter By Id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

segment_audiences_force_execute_audience_run

Force Execute Audience Run Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id

segment_audiences_get_activation_from_audience

Get Activation from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
idstringYesThe id value

segment_audiences_get_audience

Get Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
includestringNoAdditional resource to include, support schedules only. This parameter exists in alpha.

segment_audiences_get_audience_preview

Get Audience Preview Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value

segment_audiences_get_audience_schedule_from_space_and_audience

Get Audience Schedule from Space And Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
scheduleIdstringYesSchedule Id

segment_audiences_get_computed_trait

Get Computed Trait Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value

segment_audiences_get_filter_by_id

Get Filter By Id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

segment_audiences_get_space

Get Space Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id

segment_audiences_list_activations_from_audience

List Activations from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
paginationobjectNoOptional pagination. This parameter exists in alpha.

segment_audiences_list_audience_consumers_from_space_and_audience

List Audience Consumers from Space And Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
paginationobjectNoInformation about the pagination of this response. See pagination for more info. This parameter exists in alpha.
searchobjectNoOptional search criteria This parameter exists in alpha.
sortobjectNoOptional sort criteria This parameter exists in alpha.

segment_audiences_list_audience_schedules_from_space_and_audience

List Audience Schedules from Space And Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value

segment_audiences_list_audiences

List Audiences Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
searchobjectNoOptional search criteria This parameter exists in alpha.
paginationobjectNoInformation about the pagination of this response. See pagination for more info. This parameter exists in alpha.
includestringNoAdditional resource to include, support schedules only. This parameter exists in alpha.

segment_audiences_list_computed_traits

List Computed Traits Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
paginationobjectNoInformation 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:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
paginationobjectNoOptional pagination. This parameter exists in alpha.

segment_audiences_list_filters_for_space

List Filters for Space Parameters:
ParameterTypeRequiredDefaultDescription
integrationIdstringYesThe Space Id for which to fetch filters This parameter exists in beta.
paginationobjectNoPagination parameters. This parameter exists in beta.

segment_audiences_list_spaces

List Spaces Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoPagination params This parameter exists in alpha.

segment_audiences_list_supported_destinations_from_audience

List Supported Destinations from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceTypestringYesAudience Type
slugstringNoOptional destination slug to filter results. This parameter exists in alpha.
actionIdstringNoOptional destination action id to filter results. This parameter exists in alpha.

segment_audiences_remove_activation_from_audience

Remove Activation from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
idstringYesThe id value

segment_audiences_remove_audience_from_space

Remove Audience from Space Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value

segment_audiences_remove_audience_schedule_from_audience

Remove Audience Schedule from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
scheduleIdstringYesSchedule Id

segment_audiences_remove_computed_trait_from_space

Remove Computed Trait from Space Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value

segment_audiences_remove_destination_from_audience

Remove Destination from Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
destinationIdstringYesDestination Id

segment_audiences_replace_messaging_subscriptions_in_spaces

Replace Messaging Subscriptions in Spaces Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
subscriptionsobject[]YesAn array of subscriptions.

segment_audiences_update_activation_for_audience

Update Activation for Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
idstringYesThe id value
activationNamestringNoActivation name. For Warehouse Destinations, this is used as the table name.
destinationMappingobjectNoDefines 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.
displayNamestringNoOptional human-readable label for the activation. Only supported for Warehouse Destinations. Send null to clear. When omitted, the activationName is used as the label.
enabledbooleanNoDetermines whether an activation is enabled.
performResyncbooleanNoDetermines 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.
personalizationobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
definitionobjectNoRepresents the Compute Query Language definition of the computation and type of computation.
descriptionstringNoThe description of the computation.
enabledbooleanNoEnabled/disabled status for the audience.
namestringNoThe name of the computation.
optionsobjectNoRepresents the options of Including Anonymous users and Historical Data.

segment_audiences_update_audience_schedule_for_audience

Update Audience Schedule for Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
scheduleIdstringYesSchedule Id
configobjectNoConfiguration for PERIODIC or SPECIFIC_DAYS strategies.
strategystringNoStrategy of the audience schedule (periodic or specific days).

segment_audiences_update_computed_trait_for_space

Update Computed Trait for Space Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
idstringYesThe id value
definitionobjectNoQuery language definition and type. Note: The definition for a Computed Trait updated using the API is not editable through the Segment App.
descriptionstringNoThe description of the computation.
enabledbooleanNoEnabled/disabled status for the computed trait.
namestringNoThe name of the computation.

segment_audiences_update_destination_for_audience

Update Destination for Audience Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesSpace Id
audienceIdstringYesAudience Id
destinationIdstringYesDestination Id
connectionSettingsobjectNoThe settings that a Destination requires to create audiences on a third-party platform.
idSyncConfigurationobject[]NoIdentifier 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
descriptionstringNoThe description of the filter.
dropbooleanNoWhether the event is dropped.
enabledbooleanNoWhether the filter is enabled.
ifstringNoThe “if” statement for a filter.
integrationIdstringNoThe Integration id of the resource.
namestringNoThe name of the filter.