Add audience_ids to AI External Pages API (Preview)

descriptions/0/api.intercom.io.yaml

@@ -916,6 +916,9 @@ paths:
                       created_at: 1734537269
                       updated_at: 1734537269
                       last_ingested_at: 1734537269
+                      audience_ids:
+                      - 1
+                      - 2
                     - id: '18'
                       type: external_page
                       title: My External Content
@@ -1002,6 +1005,9 @@ paths:
                     created_at: 1734537273
                     updated_at: 1734537274
                     last_ingested_at: 1734537274
+                    audience_ids:
+                    - 1
+                    - 2
               schema:
                 "$ref": "#/components/schemas/external_page"
         '401':
@@ -1018,6 +1024,19 @@ paths:
                       message: Access Token Invalid
               schema:
                 "$ref": "#/components/schemas/error"
+        '404':
+          description: Unknown audience IDs
+          content:
+            application/json:
+              examples:
+                Unknown audience IDs:
+                  value:
+                    type: error.list
+                    errors:
+                    - code: parameter_invalid
+                      message: 'audience_ids contains unknown audience IDs: 999'
+              schema:
+                "$ref": "#/components/schemas/error"
       requestBody:
         content:
           application/json:
@@ -1033,6 +1052,9 @@ paths:
                   source_id: 44
                   title: Test
                   url: https://www.example.com
+                  audience_ids:
+                  - 1
+                  - 2
   "/ai/external_pages/{id}":
     parameters:
     - name: id
@@ -1075,6 +1097,9 @@ paths:
                     created_at: 1734537276
                     updated_at: 1734537276
                     last_ingested_at: 1734537276
+                    audience_ids:
+                    - 1
+                    - 2
               schema:
                 "$ref": "#/components/schemas/external_page"
         '401':
@@ -1124,6 +1149,9 @@ paths:
                     created_at: 1734537278
                     updated_at: 1734537278
                     last_ingested_at: 1734537278
+                    audience_ids:
+                    - 1
+                    - 2
               schema:
                 "$ref": "#/components/schemas/external_page"
         '401':
@@ -1174,6 +1202,9 @@ paths:
                     created_at: 1734537280
                     updated_at: 1734537281
                     last_ingested_at: 1734537281
+                    audience_ids:
+                    - 1
+                    - 2
               schema:
                 "$ref": "#/components/schemas/external_page"
         '401':
@@ -1190,6 +1221,19 @@ paths:
                       message: Access Token Invalid
               schema:
                 "$ref": "#/components/schemas/error"
+        '404':
+          description: Unknown audience IDs
+          content:
+            application/json:
+              examples:
+                Unknown audience IDs:
+                  value:
+                    type: error.list
+                    errors:
+                    - code: parameter_invalid
+                      message: 'audience_ids contains unknown audience IDs: 999'
+              schema:
+                "$ref": "#/components/schemas/error"
       requestBody:
         content:
           application/json:
@@ -1205,6 +1249,9 @@ paths:
                   source_id: 47
                   title: Test
                   url: https://www.example.com
+                  audience_ids:
+                  - 1
+                  - 2
   "/articles":
     get:
       summary: List all articles
@@ -23839,6 +23886,20 @@ components:
           description: The identifier for the external page which was given by the
             source. Must be unique for the source.
           example: '5678'
+        audience_ids:
+          type: array
+          nullable: true
+          description: >-
+            The list of audience IDs to target this external page to for Fin AI Agent.
+            Omitting the field preserves any default audience segments inherited from the parent content import source.
+            Pass an explicit array to override inherited defaults with the given set.
+            Pass `[]` to clear all audience memberships (even if the source has defaults).
+            Unknown audience IDs return a `404` error with no partial commit.
+          items:
+            type: integer
+          example:
+          - 1
+          - 2
       required:
       - title
       - html
@@ -26483,6 +26544,17 @@ components:
           format: date-time
           description: The time when the external page was last ingested.
           example: 1672928610
+        audience_ids:
+          type: array
+          nullable: true
+          description: >-
+            The list of audience IDs this external page is targeted to for Fin AI Agent.
+            Empty array means no audience targeting is set.
+          items:
+            type: integer
+          example:
+          - 1
+          - 2
       required:
       - id
       - type
@@ -30038,6 +30110,19 @@ components:
           description: The identifier for the external page which was given by the
             source. Must be unique for the source.
           example: '5678'
+        audience_ids:
+          type: array
+          nullable: true
+          description: >-
+            The list of audience IDs to target this external page to for Fin AI Agent.
+            Omitting the field leaves existing audience memberships unchanged (PATCH semantics).
+            Pass `[]` to clear all audience memberships.
+            Unknown audience IDs return a `404` error with no partial commit.
+          items:
+            type: integer
+          example:
+          - 1
+          - 2
       required:
       - title
       - html