Skip to content

Commit 7aaaa99

Browse files
authored
Document audience targeting fields on Content Import Sources (Preview) (#464)
* Add audience targeting fields to Content Import Source Preview spec Add audience_id and apply_audience_to_existing_content fields to the Preview OpenAPI spec (descriptions/0/) for Content Import Sources, per intercom/intercom#497303. Changes: - content_import_source response schema: add audience_id (nullable integer) - create_content_import_source_request: add optional audience_id - update_content_import_source_request: add optional audience_id and apply_audience_to_existing_content (boolean, default false) - All inline response examples updated with audience_id: null * Fix audience targeting fields: audience_id -> audience_ids (array) Update Preview spec to match updated PR intercom/intercom#497303: - Rename audience_id to audience_ids throughout - Response schema: type is now array of integers (always returns []) - Request schemas: accept single integer or array via oneOf (nullable) - All inline examples updated to audience_ids: []
1 parent b12eb71 commit 7aaaa99

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -642,6 +642,7 @@ paths:
642642
sync_behavior: automatic
643643
created_at: 1734537259
644644
updated_at: 1734537259
645+
audience_ids: []
645646
- id: 34
646647
type: content_import_source
647648
last_synced_at: 1734537259
@@ -650,6 +651,7 @@ paths:
650651
sync_behavior: automatic
651652
created_at: 1734537259
652653
updated_at: 1734537259
654+
audience_ids: []
653655
- id: 35
654656
type: content_import_source
655657
last_synced_at: 1734537259
@@ -658,6 +660,7 @@ paths:
658660
sync_behavior: automatic
659661
created_at: 1734537259
660662
updated_at: 1734537259
663+
audience_ids: []
661664
pages:
662665
type: pages
663666
page: 1
@@ -709,6 +712,7 @@ paths:
709712
sync_behavior: api
710713
created_at: 1734537261
711714
updated_at: 1734537261
715+
audience_ids: []
712716
schema:
713717
"$ref": "#/components/schemas/content_import_source"
714718
'401':
@@ -801,6 +805,7 @@ paths:
801805
sync_behavior: api
802806
created_at: 1734537265
803807
updated_at: 1734537265
808+
audience_ids: []
804809
schema:
805810
"$ref": "#/components/schemas/content_import_source"
806811
'401':
@@ -844,6 +849,7 @@ paths:
844849
sync_behavior: api
845850
created_at: 1734537267
846851
updated_at: 1734537267
852+
audience_ids: []
847853
schema:
848854
"$ref": "#/components/schemas/content_import_source"
849855
'401':
@@ -20952,6 +20958,13 @@ components:
2095220958
format: date-time
2095320959
description: The time when the content import source was last updated.
2095420960
example: 1672928610
20961+
audience_ids:
20962+
type: array
20963+
items:
20964+
type: integer
20965+
description: The unique identifiers for the audiences associated with this content import source.
20966+
example:
20967+
- 5678
2095520968
required:
2095620969
- id
2095720970
- type
@@ -22275,6 +22288,16 @@ components:
2227522288
type: string
2227622289
description: The URL of the content import source.
2227722290
example: https://help.example.com
22291+
audience_ids:
22292+
nullable: true
22293+
description: The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers.
22294+
example:
22295+
- 5678
22296+
oneOf:
22297+
- type: integer
22298+
- type: array
22299+
items:
22300+
type: integer
2227822301
required:
2227922302
- sync_behavior
2228022303
- url
@@ -28380,6 +28403,21 @@ components:
2838028403
description: The URL of the content import source. This may only be different
2838128404
from the existing value if the sync behavior is API.
2838228405
example: https://help.example.com
28406+
audience_ids:
28407+
nullable: true
28408+
description: The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers. Set to null or an empty array to remove all audiences.
28409+
example:
28410+
- 5678
28411+
oneOf:
28412+
- type: integer
28413+
- type: array
28414+
items:
28415+
type: integer
28416+
apply_audience_to_existing_content:
28417+
type: boolean
28418+
description: When true, the audience will be applied to all existing external pages belonging to this content import source.
28419+
default: false
28420+
example: false
2838328421
required:
2838428422
- sync_behavior
2838528423
- url

0 commit comments

Comments
 (0)