2.11 updates

Author: Eclairemoy

descriptions/2.11/api.intercom.io.yaml

@@ -1363,7 +1363,7 @@ paths:
 
         Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.
 
-        {% admonition type="attention" name="Using `company_id`" %}
+        {% admonition type="warning" name="Using `company_id`" %}
           You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.
         {% /admonition %}
       responses:
@@ -1666,7 +1666,7 @@ paths:
       description: |
         You can update a single company using the Intercom provisioned `id`.
 
-        {% admonition type="attention" name="Using `company_id`" %}
+        {% admonition type="warning" name="Using `company_id`" %}
           When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
         {% /admonition %}
       responses:
@@ -3716,7 +3716,6 @@ paths:
         | email                              | String                         |
         | email_domain                       | String                         |
         | phone                              | String                         |
-        | formatted_phone                    | String                         |
         | external_id                        | String                         |
         | created_at                         | Date (UNIX Timestamp)          |
         | signed_up_at                       | Date (UNIX Timestamp)          |
@@ -3754,7 +3753,7 @@ paths:
 
         ### Accepted Operators
 
-        {% admonition type="attention" name="Searching based on `created_at`" %}
+        {% admonition type="warning" name="Searching based on `created_at`" %}
           You cannot use the `<=` or `>=` operators to search by `created_at`.
         {% /admonition %}
 
@@ -4878,7 +4877,7 @@ paths:
 
         ### Accepted Fields
 
-        Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`).
+        Most keys listed in the table below are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`).
         The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result.
 
         | Field                                     | Type                                                                                                                                                   |
@@ -5816,8 +5815,11 @@ paths:
       - Conversations
       operationId: autoAssignConversation
       description: |
+        {% admonition type="danger" name="Deprecation of Run Assignment Rules" %}
+        Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.
+        {% /admonition %}
         You can let a conversation be automatically assigned following assignment rules.
-        {% admonition type="attention" name="When using workflows" %}
+        {% admonition type="warning" name="When using workflows" %}
         It is not possible to use this endpoint with Workflows.
         {% /admonition %}
       responses:
@@ -5966,7 +5968,7 @@ paths:
       description: |+
         You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
 
-        {% admonition type="attention" name="Contacts without an email" %}
+        {% admonition type="warning" name="Contacts without an email" %}
         If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.
         {% /admonition %}
 
@@ -6071,7 +6073,7 @@ paths:
       description: |+
         You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
 
-        {% admonition type="attention" name="Contacts without an email" %}
+        {% admonition type="warning" name="Contacts without an email" %}
         If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.
         {% /admonition %}
 
@@ -10337,14 +10339,15 @@ paths:
         ### Accepted Fields
 
         Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`).
+        The `description` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` description - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result.
 
         | Field                                     | Type                                                                                     |
         | :---------------------------------------- | :--------------------------------------------------------------------------------------- |
         | id                                        | String                                                                                   |
         | created_at                                | Date (UNIX timestamp)                                                                    |
         | updated_at                                | Date (UNIX timestamp)                                                                    |
-        | _default_title_                           | String                                                                                   |
-        | _default_description_                     | String                                                                                   |
+        | title                                     | String                                                                                   |
+        | description                               | String                                                                                   |
         | category                                  | String                                                                                   |
         | ticket_type_id                            | String                                                                                   |
         | contact_ids                               | String                                                                                   |
@@ -12757,6 +12760,11 @@ components:
       description: An object containing companies meta data about the companies that
         a contact has. Up to 10 will be displayed here. Use the url to get more.
       properties:
+        data:
+          type: array
+          description: An array of company data objects attached to the contact.
+          items:
+            "$ref": "#/components/schemas/company_data"
         url:
           type: string
           format: uri
@@ -12776,6 +12784,26 @@ components:
         - url
         - total_count
         - has_more
+    company_data:
+      title: Company Data
+      type: object
+      description: An object containing data about the companies that a contact is associated with.
+      properties:
+        id:
+          type: string
+          description: The unique identifier for the company which is given by Intercom.
+          example: 5ba682d23d7cf92bef87bfd4
+        type:
+          type: string
+          description: The type of the object
+          enum:
+          - company
+          example: company
+        url:
+          type: string
+          format: uri
+          description: The relative URL of the company.
+          example: "/companies/5ba682d23d7cf92bef87bfd4"
     contact_deleted:
       title: Contact Deleted
       type: object
@@ -12834,7 +12862,7 @@ components:
     contact_location:
       title: Contact Location
       type: object
-      description: An object containing location meta data about a Intercom contact.
+      description: An object containing location metadata about a Intercom contact.
       properties:
         type:
           type: string
@@ -13620,14 +13648,24 @@ components:
     conversation_source:
       title: Conversation source
       type: object
-      description: The Conversation Part that originated this conversation, which
-        can be Contact, Admin, Campaign, Automated or Operator initiated.
+      description: The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.
       properties:
         type:
           type: string
           description: This includes conversation, email, facebook, instagram, phone_call,
             phone_switch, push, sms, twitter and whatsapp.
           example: conversation
+          enum:
+          - conversation
+          - email
+          - facebook
+          - instagram
+          - phone_call
+          - phone_switch
+          - push
+          - sms
+          - twitter
+          - whatsapp
         id:
           type: string
           description: The id representing the message.
@@ -15250,6 +15288,10 @@ components:
         - filesize
         - width
         - height
+    filter:
+      anyOf:
+      - "$ref": "#/components/schemas/single_filter_search_request"
+      - "$ref": "#/components/schemas/multiple_filter_search_request"
     group_content:
       title: Group Content
       type: object
@@ -15623,7 +15665,7 @@ components:
         - conversation_id
     multiple_filter_search_request:
       title: Multiple Filter Search Request
-      description: Search using Intercoms Search APIs with more than one filter.
+      description: Search with more than one filter.
       type: object
       properties:
         operator:
@@ -15634,17 +15676,10 @@ components:
           description: An operator to allow boolean inspection between multiple fields.
           example: AND
         value:
-          oneOf:
-          - type: array
-            description: Add mutiple filters.
-            title: multiple filter search request
-            items:
-              "$ref": "#/components/schemas/multiple_filter_search_request"
-          - type: array
-            description: Add a single filter field.
-            title: single filter search request
-            items:
-              "$ref": "#/components/schemas/single_filter_search_request"
+          type: array
+          items:
+            "$ref": "#/components/schemas/filter"
+          description: Nested filters or queries.
     news_item:
       title: News Item
       type: object
@@ -16270,7 +16305,51 @@ components:
         field:
           type: string
           description: The accepted field that you want to search on.
-          example: created_at
+          enum:
+          - id
+          - role
+          - name
+          - avatar
+          - owner_id
+          - email
+          - email_domain
+          - phone
+          - external_id
+          - created_at
+          - signed_up_at
+          - updated_at
+          - last_seen_at
+          - last_contacted_at
+          - last_replied_at
+          - last_email_opened_at
+          - last_email_clicked_at
+          - language_override
+          - browser
+          - browser_language
+          - os
+          - location.country
+          - location.city
+          - location.region
+          - unsubscribed_from_emails
+          - marked_email_as_spam
+          - has_hard_bounced
+          - ios_last_seen_at
+          - ios_app_version
+          - ios_device
+          - ios_app_device
+          - ios_os_version
+          - ios_app_name
+          - ios_sdk_version
+          - android_last_seen_at
+          - android_app_version
+          - android_device
+          - android_app_device
+          - android_app_name
+          - android_sdk_version
+          - segment_id
+          - tag_id
+          - custom_attributes.*
+          example: custom_attributes.favorite_color
         operator:
           type: string
           enum:
@@ -16288,7 +16367,14 @@ components:
             search for the value.
           example: ">"
         value:
-          type: string
+          oneOf:
+          - type: string
+          - type: integer
+          - type: array
+            items:
+              oneOf:
+              - type: string
+              - type: integer
           description: The value that you want to search on.
           example: '73732934'
     sla_applied: