Add users/companies to tag response (preview)

descriptions/0/api.intercom.io.yaml

@@ -14828,8 +14828,10 @@ paths:
                     type: tag
                     id: '105'
                     name: test
+                    users: []
+                    companies: [{ "id": "valid-123", "tagged": true }]
               schema:
-                "$ref": "#/components/schemas/tag_basic"
+                "$ref": "#/components/schemas/tag_create_response"
         '400':
           description: Invalid parameters
           content:
@@ -14844,27 +14846,6 @@ paths:
                       message: invalid tag parameters
               schema:
                 "$ref": "#/components/schemas/error"
-        '404':
-          description: User  not found
-          content:
-            application/json:
-              examples:
-                Company not found:
-                  value:
-                    type: error.list
-                    request_id: 23c998cc-32b8-435d-9653-932c15809460
-                    errors:
-                    - code: company_not_found
-                      message: Company Not Found
-                User  not found:
-                  value:
-                    type: error.list
-                    request_id: 7358f78d-f122-45dd-a2e1-c2261300c38a
-                    errors:
-                    - code: not_found
-                      message: User Not Found
-              schema:
-                "$ref": "#/components/schemas/error"
         '401':
           description: Unauthorized
           content:
@@ -14897,18 +14878,6 @@ paths:
                 summary: Invalid parameters
                 value:
                   test: invalid
-              company_not_found:
-                summary: Company not found
-                value:
-                  name: test
-                  companies:
-                  - company_id: '123'
-              user_not_found:
-                summary: User  not found
-                value:
-                  name: test
-                  users:
-                  - id: '123'
   "/tags/{id}":
     get:
       summary: Find a specific tag
@@ -27333,6 +27302,46 @@ components:
           type: string
           description: The name of the tag
           example: Test tag
+    tag_create_response:
+      title: Create or Update Tag Response
+      description: The response for creating or updating a tag, including the entities
+        that were tagged or untagged.
+      allOf:
+        - "$ref": "#/components/schemas/tag_basic"
+        - type: object
+          properties:
+            users:
+              type: array
+              nullable: true
+              description: The users that were tagged or untagged.
+              items:
+                type: object
+                properties:
+                  id:
+                    type: string
+                    description: The Intercom ID of the user.
+                    example: '6329e838deab40166d1a53f7'
+                  tagged:
+                    type: boolean
+                    description: Whether the user was tagged (true) or untagged (false).
+                    example: true
+              example: []
+            companies:
+              type: array
+              nullable: true
+              description: The companies that were tagged or untagged.
+              items:
+                type: object
+                properties:
+                  id:
+                    type: string
+                    description: The Intercom ID of the company.
+                    example: '6329e838deab40166d1a5400'
+                  tagged:
+                    type: boolean
+                    description: Whether the company was tagged (true) or untagged (false).
+                    example: true
+              example: []
     tag_company_request:
       description: You can tag a single company or a list of companies.
       type: object