> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # segment-audiences > Segment Audiences — manage audiences, computed traits, spaces, and activations **Server path:** `/segment-audiences` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | [`segment_audiences_add_activation_to_audience`](#segment_audiences_add_activation_to_audience) | Add Activation to Audience | | [`segment_audiences_add_audience_schedule_to_audience`](#segment_audiences_add_audience_schedule_to_audience) | Add Audience Schedule to Audience | | [`segment_audiences_add_destination_to_audience`](#segment_audiences_add_destination_to_audience) | Add Destination to Audience | | [`segment_audiences_batch_query_messaging_subscriptions_for_space`](#segment_audiences_batch_query_messaging_subscriptions_for_space) | Batch Query Messaging Subscriptions for Space | | [`segment_audiences_create_audience`](#segment_audiences_create_audience) | Create Audience | | [`segment_audiences_create_audience_preview`](#segment_audiences_create_audience_preview) | Create Audience Preview | | [`segment_audiences_create_computed_trait`](#segment_audiences_create_computed_trait) | Create Computed Trait | | [`segment_audiences_create_download`](#segment_audiences_create_download) | Create Download | | [`segment_audiences_create_filter_for_space`](#segment_audiences_create_filter_for_space) | Create Filter for Space | | [`segment_audiences_delete_filter_by_id`](#segment_audiences_delete_filter_by_id) | Delete Filter By Id | | [`segment_audiences_force_execute_audience_run`](#segment_audiences_force_execute_audience_run) | Force Execute Audience Run | | [`segment_audiences_get_activation_from_audience`](#segment_audiences_get_activation_from_audience) | Get Activation from Audience | | [`segment_audiences_get_audience`](#segment_audiences_get_audience) | Get Audience | | [`segment_audiences_get_audience_preview`](#segment_audiences_get_audience_preview) | Get Audience Preview | | [`segment_audiences_get_audience_schedule_from_space_and_audience`](#segment_audiences_get_audience_schedule_from_space_and_audience) | Get Audience Schedule from Space And Audience | | [`segment_audiences_get_computed_trait`](#segment_audiences_get_computed_trait) | Get Computed Trait | | [`segment_audiences_get_filter_by_id`](#segment_audiences_get_filter_by_id) | Get Filter By Id | | [`segment_audiences_get_space`](#segment_audiences_get_space) | Get Space | | [`segment_audiences_list_activations_from_audience`](#segment_audiences_list_activations_from_audience) | List Activations from Audience | | [`segment_audiences_list_audience_consumers_from_space_and_audience`](#segment_audiences_list_audience_consumers_from_space_and_audience) | List Audience Consumers from Space And Audience | | [`segment_audiences_list_audience_schedules_from_space_and_audience`](#segment_audiences_list_audience_schedules_from_space_and_audience) | List Audience Schedules from Space And Audience | | [`segment_audiences_list_audiences`](#segment_audiences_list_audiences) | List Audiences | | [`segment_audiences_list_computed_traits`](#segment_audiences_list_computed_traits) | List Computed Traits | | [`segment_audiences_list_destinations_from_audience`](#segment_audiences_list_destinations_from_audience) | List Destinations from Audience | | [`segment_audiences_list_filters_for_space`](#segment_audiences_list_filters_for_space) | List Filters for Space | | [`segment_audiences_list_spaces`](#segment_audiences_list_spaces) | List Spaces | | [`segment_audiences_list_supported_destinations_from_audience`](#segment_audiences_list_supported_destinations_from_audience) | List Supported Destinations from Audience | | [`segment_audiences_remove_activation_from_audience`](#segment_audiences_remove_activation_from_audience) | Remove Activation from Audience | | [`segment_audiences_remove_audience_from_space`](#segment_audiences_remove_audience_from_space) | Remove Audience from Space | | [`segment_audiences_remove_audience_schedule_from_audience`](#segment_audiences_remove_audience_schedule_from_audience) | Remove Audience Schedule from Audience | | [`segment_audiences_remove_computed_trait_from_space`](#segment_audiences_remove_computed_trait_from_space) | Remove Computed Trait from Space | | [`segment_audiences_remove_destination_from_audience`](#segment_audiences_remove_destination_from_audience) | Remove Destination from Audience | | [`segment_audiences_replace_messaging_subscriptions_in_spaces`](#segment_audiences_replace_messaging_subscriptions_in_spaces) | Replace Messaging Subscriptions in Spaces | | [`segment_audiences_update_activation_for_audience`](#segment_audiences_update_activation_for_audience) | Update Activation for Audience | | [`segment_audiences_update_audience_for_space`](#segment_audiences_update_audience_for_space) | Update Audience for Space | | [`segment_audiences_update_audience_schedule_for_audience`](#segment_audiences_update_audience_schedule_for_audience) | Update Audience Schedule for Audience | | [`segment_audiences_update_computed_trait_for_space`](#segment_audiences_update_computed_trait_for_space) | Update Computed Trait for Space | | [`segment_audiences_update_destination_for_audience`](#segment_audiences_update_destination_for_audience) | Update Destination for Audience | | [`segment_audiences_update_filter_by_id`](#segment_audiences_update_filter_by_id) | Update Filter By Id | *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "connectionId": { "type": "string", "description": "Connection Id" }, "activationName": { "type": "string", "description": "Activation name. For Warehouse Destinations, this is used as the table name." }, "activationType": { "type": "string", "description": "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": { "description": "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": { "type": "string", "description": "Optional human-readable label for the activation. Only supported for Warehouse Destinations. When omitted, the activationName is used as the label." }, "enabled": { "type": "boolean", "description": "Determines whether an activation is enabled." }, "performResync": { "type": "boolean", "description": "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": { "description": "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." } }, "required": [ "PCID", "spaceId", "audienceId", "connectionId", "activationName", "activationType", "performResync", "personalization" ] } ``` *** ## 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). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "config": { "type": "object", "description": "Configuration for PERIODIC or SPECIFIC_DAYS strategies." }, "strategy": { "type": "string", "description": "Strategy of the audience schedule (periodic or specific days).", "enum": [ "PERIODIC", "SPECIFIC_DAYS" ] } }, "required": [ "PCID", "spaceId", "id", "config", "strategy" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "connectionSettings": { "description": "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": { "description": "The Destination." }, "idSyncConfiguration": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "description": "The id type to sync. Examples: user_id, email, anonymous_id." }, "strategy": { "type": "string", "description": "The rule for selecting which identifiers to sync from a profile. Possible values: first: Syncs only the oldest recorded value. last: Syncs only the most recently updated value. all: Syncs every value found on the profile (sends multiple events)." }, "mapTo": { "type": "string", "description": "Optional destination-specific identifier to map to (for example, \"Email_Address_c\")." } }, "required": [ "externalId", "strategy" ] }, "description": "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." } }, "required": [ "PCID", "spaceId", "audienceId", "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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Key is the phone number or email." }, "type": { "type": "string", "enum": [ "ANDROID_PUSH", "EMAIL", "IOS_PUSH", "SMS", "WHATSAPP" ], "description": "Type is communication medium used." } }, "required": [ "key", "type" ] }, "description": "A list of subscriptions to retrieve subscription status." } }, "required": [ "PCID", "spaceId", "subscriptions" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceType": { "type": "string", "description": "Denotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED.", "enum": [ "ACCOUNTS", "LINKED", "USERS" ] }, "definition": { "description": "Query language definition." }, "description": { "type": "string", "description": "Description of the audience." }, "enabled": { "type": "boolean", "description": "Determines whether a computation is enabled." }, "name": { "type": "string", "description": "Name of the audience." }, "options": { "description": "Represents the options of Including Anonymous users and Historical Data." } }, "required": [ "PCID", "spaceId", "audienceType", "definition", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceType": { "type": "string", "description": "Denotes the type of audience product. Possible values: USERS, ACCOUNTS, LINKED.", "enum": [ "ACCOUNTS", "LINKED", "USERS" ] }, "definition": { "description": "Query language definition." }, "options": { "description": "Options which should be applied when segmenting audiences." } }, "required": [ "PCID", "spaceId", "audienceType", "definition" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "definition": { "description": "Represents the Compute Query Language definition of the computation and type of computation." }, "description": { "type": "string", "description": "The description of the computation." }, "enabled": { "type": "boolean", "description": "Determines whether a computation is enabled." }, "name": { "type": "string", "description": "The name of the computation." }, "options": { "description": "Options which should be applied when aggregating computed traits." } }, "required": [ "PCID", "spaceId", "definition", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collectionId": { "type": "string", "description": "The collection's unique id." }, "hour": { "type": "string", "description": "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." } }, "required": [ "PCID", "collectionId", "hour" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description of the filter." }, "drop": { "type": "boolean", "description": "Whether the event is dropped." }, "enabled": { "type": "boolean", "description": "Whether the filter is enabled." }, "if": { "type": "string", "description": "The \"if\" statement for a filter." }, "integrationId": { "type": "string", "description": "The Space id to filter on." }, "name": { "type": "string", "description": "The name of the filter." } }, "required": [ "PCID", "if", "integrationId", "name" ] } ``` *** ## segment\_audiences\_delete\_filter\_by\_id Delete Filter By Id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" } }, "required": [ "PCID", "spaceId", "audienceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "audienceId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "include": { "type": "string", "description": "Additional resource to include, support schedules only. This parameter exists in alpha.", "enum": [ "schedules" ] } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "scheduleId": { "type": "string", "description": "Schedule Id" } }, "required": [ "PCID", "spaceId", "id", "scheduleId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## segment\_audiences\_get\_filter\_by\_id Get Filter By Id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## segment\_audiences\_get\_space Get Space **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `spaceId` | string | Yes | — | Space Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" } }, "required": [ "PCID", "spaceId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "pagination": { "type": "object", "description": "Optional pagination. This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "integer", "description": "The number of items to retrieve in a page, between 1 and 1000." } }, "required": [ "count" ] } }, "required": [ "PCID", "spaceId", "audienceId" ] } ``` *** ## 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](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "pagination": { "type": "object", "description": "Information about the pagination of this response. [See pagination](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "integer", "description": "The number of items to retrieve in a page, between 1 and 1000." } }, "required": [ "count" ] }, "search": { "type": "object", "description": "Optional search criteria This parameter exists in alpha.", "properties": { "type": { "type": "string", "description": "Field to filter by.", "enum": [ "DEFINITION", "KEY", "NAME" ] }, "query": { "type": "string", "description": "Text to match against the selected field (max 255 characters). When searching by KEY, a prefix match is used. For all other options, a full wildcard search will be used." } }, "required": [ "query", "type" ] }, "sort": { "type": "object", "description": "Optional sort criteria This parameter exists in alpha.", "properties": { "field": { "type": "string", "description": "Field to sort by.", "enum": [ "CREATED_AT", "NAME", "UPDATED_AT" ] }, "direction": { "type": "string", "description": "Sort direction (ascending or descending).", "enum": [ "ASC", "DESC" ] } }, "required": [ "direction", "field" ] } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha. | | `include` | string | No | — | Additional resource to include, support schedules only. This parameter exists in alpha. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "search": { "type": "object", "description": "Optional search criteria This parameter exists in alpha.", "properties": { "type": { "type": "string", "description": "Field to filter by.", "enum": [ "DEFINITION", "KEY", "NAME" ] }, "query": { "type": "string", "description": "Text to match against the selected field (max 255 characters). When searching by KEY, a prefix match is used. For all other options, a full wildcard search will be used." } }, "required": [ "query", "type" ] }, "pagination": { "type": "object", "description": "Information about the pagination of this response. [See pagination](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "number", "description": "The number of items to retrieve in a page, between 1 and 200." } }, "required": [ "count" ] }, "include": { "type": "string", "description": "Additional resource to include, support schedules only. This parameter exists in alpha.", "enum": [ "schedules" ] } }, "required": [ "PCID", "spaceId" ] } ``` *** ## 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](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "pagination": { "type": "object", "description": "Information about the pagination of this response. [See pagination](https://docs.segmentapis.com/tag/Pagination/#section/Pagination-parameters) for more info. This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "integer", "description": "The number of items to retrieve in a page, between 1 and 1000." } }, "required": [ "count" ] } }, "required": [ "PCID", "spaceId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "pagination": { "type": "object", "description": "Optional pagination. This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "integer", "description": "The number of items to retrieve in a page, between 1 and 1000." } }, "required": [ "count" ] } }, "required": [ "PCID", "spaceId", "audienceId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "integrationId": { "type": "string", "description": "The Space Id for which to fetch filters This parameter exists in beta." }, "pagination": { "type": "object", "description": "Pagination parameters. This parameter exists in beta.", "properties": { "cursor": { "type": "number", "description": "The offset." }, "count": { "type": "number", "description": "The number of items to retrieve in a page, between 1 and 10." } }, "required": [ "count" ] } }, "required": [ "PCID", "integrationId" ] } ``` *** ## segment\_audiences\_list\_spaces List Spaces **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------------- | | `pagination` | object | No | — | Pagination params This parameter exists in alpha. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pagination": { "type": "object", "description": "Pagination params This parameter exists in alpha.", "properties": { "cursor": { "type": "string", "description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque." }, "count": { "type": "integer", "description": "The number of items to retrieve in a page, between 1 and 1000." } }, "required": [ "count" ] } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceType": { "type": "string", "description": "Audience Type" }, "slug": { "type": "string", "description": "Optional destination slug to filter results. This parameter exists in alpha." }, "actionId": { "type": "string", "description": "Optional destination action id to filter results. This parameter exists in alpha." } }, "required": [ "PCID", "spaceId", "audienceType" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "audienceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "scheduleId": { "type": "string", "description": "Schedule Id" } }, "required": [ "PCID", "spaceId", "id", "scheduleId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "destinationId": { "type": "string", "description": "Destination Id" } }, "required": [ "PCID", "spaceId", "audienceId", "destinationId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Key is the phone number or email." }, "type": { "type": "string", "enum": [ "ANDROID_PUSH", "EMAIL", "IOS_PUSH", "SMS", "WHATSAPP" ], "description": "Type is communication medium used." }, "status": { "type": "string", "enum": [ "DID_NOT_SUBSCRIBE", "SUBSCRIBED", "UNSUBSCRIBED" ], "description": "The user subscribed, unsubscribed, or on initial status globally." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the group." }, "status": { "type": "string", "description": "The user subscribed, unsubscribed, or on initial status." } } }, "description": "Optional groups subscription status." } }, "required": [ "key", "type" ] }, "description": "An array of subscriptions." } }, "required": [ "PCID", "spaceId", "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 | null | 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. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "id": { "type": "string", "description": "The id value" }, "activationName": { "type": "string", "description": "Activation name. For Warehouse Destinations, this is used as the table name." }, "destinationMapping": { "description": "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": { "type": [ "string", "null" ], "description": "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": { "type": "boolean", "description": "Determines whether an activation is enabled." }, "performResync": { "type": "boolean", "description": "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": { "description": "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." } }, "required": [ "PCID", "spaceId", "audienceId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "definition": { "description": "Represents the Compute Query Language definition of the computation and type of computation." }, "description": { "type": "string", "description": "The description of the computation." }, "enabled": { "type": "boolean", "description": "Enabled/disabled status for the audience." }, "name": { "type": "string", "description": "The name of the computation." }, "options": { "description": "Represents the options of Including Anonymous users and Historical Data." } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "scheduleId": { "type": "string", "description": "Schedule Id" }, "config": { "type": "object", "description": "Configuration for PERIODIC or SPECIFIC_DAYS strategies." }, "strategy": { "type": "string", "description": "Strategy of the audience schedule (periodic or specific days).", "enum": [ "PERIODIC", "SPECIFIC_DAYS" ] } }, "required": [ "PCID", "spaceId", "id", "scheduleId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "id": { "type": "string", "description": "The id value" }, "definition": { "description": "Query language definition and type. Note: The definition for a Computed Trait updated using the API is not editable through the Segment App." }, "description": { "type": "string", "description": "The description of the computation." }, "enabled": { "type": "boolean", "description": "Enabled/disabled status for the computed trait." }, "name": { "type": "string", "description": "The name of the computation." } }, "required": [ "PCID", "spaceId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "spaceId": { "type": "string", "description": "Space Id" }, "audienceId": { "type": "string", "description": "Audience Id" }, "destinationId": { "type": "string", "description": "Destination Id" }, "connectionSettings": { "description": "The settings that a Destination requires to create audiences on a third-party platform." }, "idSyncConfiguration": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "description": "The id type to sync. Examples: user_id, email, anonymous_id." }, "strategy": { "type": "string", "description": "The rule for selecting which identifiers to sync from a profile. Possible values: first: Syncs only the oldest recorded value. last: Syncs only the most recently updated value. all: Syncs every value found on the profile (sends multiple events)." }, "mapTo": { "type": "string", "description": "Optional destination-specific identifier to map to (for example, \"Email_Address_c\")." } }, "required": [ "externalId", "strategy" ] }, "description": "Identifier sync configuration - array of external IDs to sync with their strategies. Maximum 5 items allowed." } }, "required": [ "PCID", "spaceId", "audienceId", "destinationId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "description": { "type": "string", "description": "The description of the filter." }, "drop": { "type": "boolean", "description": "Whether the event is dropped." }, "enabled": { "type": "boolean", "description": "Whether the filter is enabled." }, "if": { "type": "string", "description": "The \"if\" statement for a filter." }, "integrationId": { "type": "string", "description": "The Integration id of the resource." }, "name": { "type": "string", "description": "The name of the filter." } }, "required": [ "PCID", "id" ] } ```