Skip to content

Commit 135faa8

Browse files
ellicenelsonclaude
andcommitted
Add audience fields to Data Connectors API spec
Add audience_type, audience_segment_ids, has_custom_predicates to the data_connector_detail response schema. Add audience_segment_ids as a writable field in create and update request schemas. Companion to intercom/intercom#500264 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent fffe17b commit 135faa8

1 file changed

Lines changed: 36 additions & 3 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23472,7 +23472,7 @@ components:
2347223472
example: false
2347323473
audiences:
2347423474
type: array
23475-
description: The user types this connector is available for.
23475+
description: The user role types this connector is available for.
2347623476
items:
2347723477
type: string
2347823478
enum:
@@ -23482,6 +23482,13 @@ components:
2348223482
example:
2348323483
- leads
2348423484
- visitors
23485+
audience_segment_ids:
23486+
type: array
23487+
description: IDs of Fin Audience segments to assign to this connector. Replaces any existing segments. Pass an empty array to clear all segments.
23488+
items:
23489+
type: string
23490+
example:
23491+
- '123'
2348523492
headers:
2348623493
type: array
2348723494
description: HTTP headers to include in the request.
@@ -23598,7 +23605,7 @@ components:
2359823605
example: false
2359923606
audiences:
2360023607
type: array
23601-
description: The audience types this connector targets.
23608+
description: The user role types this connector targets. Updating this preserves any existing custom predicate rules.
2360223609
items:
2360323610
type: string
2360423611
enum:
@@ -23608,6 +23615,13 @@ components:
2360823615
example:
2360923616
- leads
2361023617
- users
23618+
audience_segment_ids:
23619+
type: array
23620+
description: IDs of Fin Audience segments to assign. This is a full replacement — the connector will have exactly these segments after the update. Pass an empty array to clear all segments.
23621+
items:
23622+
type: string
23623+
example:
23624+
- '456'
2361123625
headers:
2361223626
type: array
2361323627
description: HTTP headers to include in the request.
@@ -23826,7 +23840,7 @@ components:
2382623840
example: false
2382723841
audiences:
2382823842
type: array
23829-
description: The audience types this connector targets.
23843+
description: The user role types this connector targets.
2383023844
items:
2383123845
type: string
2383223846
enum:
@@ -23836,6 +23850,25 @@ components:
2383623850
example:
2383723851
- users
2383823852
- leads
23853+
audience_type:
23854+
type: string
23855+
description: |
23856+
The current audience targeting mode. `everyone` targets all users. `custom` means predicate-based rules are configured (edit in the UI). `fin_audience` means Fin Audience segments are assigned.
23857+
enum:
23858+
- everyone
23859+
- custom
23860+
- fin_audience
23861+
example: everyone
23862+
audience_segment_ids:
23863+
type: array
23864+
description: IDs of the Fin Audience segments assigned to this connector. Empty when `audience_type` is not `fin_audience`.
23865+
items:
23866+
type: string
23867+
example: []
23868+
has_custom_predicates:
23869+
type: boolean
23870+
description: Whether this connector has custom predicate-based audience rules. When `true`, the rules can only be viewed and edited in the Intercom UI.
23871+
example: false
2383923872
execution_type:
2384023873
type: string
2384123874
nullable: true

0 commit comments

Comments
 (0)