Skip to content

Commit bcdc5f5

Browse files
committed
2.11 with main
1 parent 61b813a commit bcdc5f5

File tree

1 file changed

+15
-65
lines changed

1 file changed

+15
-65
lines changed

descriptions/2.11/api.intercom.io.yaml

Lines changed: 15 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1363,7 +1363,7 @@ paths:
13631363

13641364
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.
13651365

1366-
{% admonition type="warning" name="Using `company_id`" %}
1366+
{% admonition type="attention" name="Using `company_id`" %}
13671367
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.
13681368
{% /admonition %}
13691369
responses:
@@ -1666,7 +1666,7 @@ paths:
16661666
description: |
16671667
You can update a single company using the Intercom provisioned `id`.
16681668

1669-
{% admonition type="warning" name="Using `company_id`" %}
1669+
{% admonition type="attention" name="Using `company_id`" %}
16701670
When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
16711671
{% /admonition %}
16721672
responses:
@@ -3716,6 +3716,7 @@ paths:
37163716
| email | String |
37173717
| email_domain | String |
37183718
| phone | String |
3719+
| formatted_phone | String |
37193720
| external_id | String |
37203721
| created_at | Date (UNIX Timestamp) |
37213722
| signed_up_at | Date (UNIX Timestamp) |
@@ -3753,7 +3754,7 @@ paths:
37533754

37543755
### Accepted Operators
37553756

3756-
{% admonition type="warning" name="Searching based on `created_at`" %}
3757+
{% admonition type="attention" name="Searching based on `created_at`" %}
37573758
You cannot use the `<=` or `>=` operators to search by `created_at`.
37583759
{% /admonition %}
37593760

@@ -4877,7 +4878,7 @@ paths:
48774878

48784879
### Accepted Fields
48794880

4880-
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"`).
4881+
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"`).
48814882
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.
48824883

48834884
| Field | Type |
@@ -5815,11 +5816,8 @@ paths:
58155816
- Conversations
58165817
operationId: autoAssignConversation
58175818
description: |
5818-
{% admonition type="danger" name="Deprecation of Run Assignment Rules" %}
5819-
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.
5820-
{% /admonition %}
58215819
You can let a conversation be automatically assigned following assignment rules.
5822-
{% admonition type="warning" name="When using workflows" %}
5820+
{% admonition type="attention" name="When using workflows" %}
58235821
It is not possible to use this endpoint with Workflows.
58245822
{% /admonition %}
58255823
responses:
@@ -5968,7 +5966,7 @@ paths:
59685966
description: |+
59695967
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
59705968

5971-
{% admonition type="warning" name="Contacts without an email" %}
5969+
{% admonition type="attention" name="Contacts without an email" %}
59725970
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`.
59735971
{% /admonition %}
59745972

@@ -6073,7 +6071,7 @@ paths:
60736071
description: |+
60746072
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
60756073

6076-
{% admonition type="warning" name="Contacts without an email" %}
6074+
{% admonition type="attention" name="Contacts without an email" %}
60776075
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`.
60786076
{% /admonition %}
60796077

@@ -10339,15 +10337,14 @@ paths:
1033910337
### Accepted Fields
1034010338

1034110339
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"`).
10342-
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.
1034310340

1034410341
| Field | Type |
1034510342
| :---------------------------------------- | :--------------------------------------------------------------------------------------- |
1034610343
| id | String |
1034710344
| created_at | Date (UNIX timestamp) |
1034810345
| updated_at | Date (UNIX timestamp) |
10349-
| title | String |
10350-
| description | String |
10346+
| _default_title_ | String |
10347+
| _default_description_ | String |
1035110348
| category | String |
1035210349
| ticket_type_id | String |
1035310350
| contact_ids | String |
@@ -13102,7 +13099,7 @@ components:
1310213099
contact_location:
1310313100
title: Contact Location
1310413101
type: object
13105-
description: An object containing location metadata about a Intercom contact.
13102+
description: An object containing location meta data about a Intercom contact.
1310613103
properties:
1310713104
type:
1310813105
type: string
@@ -13940,7 +13937,8 @@ components:
1394013937
conversation_source:
1394113938
title: Conversation source
1394213939
type: object
13943-
description: The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.
13940+
description: The Conversation Part that originated this conversation, which
13941+
can be Contact, Admin, Campaign, Automated or Operator initiated.
1394413942
properties:
1394513943
type:
1394613944
type: string
@@ -15732,10 +15730,6 @@ components:
1573215730
- filesize
1573315731
- width
1573415732
- height
15735-
filter:
15736-
anyOf:
15737-
- "$ref": "#/components/schemas/single_filter_search_request"
15738-
- "$ref": "#/components/schemas/multiple_filter_search_request"
1573915733
group_content:
1574015734
title: Group Content
1574115735
type: object
@@ -16398,7 +16392,7 @@ components:
1639816392
- "$ref": "#/components/schemas/single_filter_search_request"
1639916393
multiple_filter_search_request:
1640016394
title: Multiple Filter Search Request
16401-
description: Search with more than one filter.
16395+
description: Search using Intercoms Search APIs with more than one filter.
1640216396
type: object
1640316397
properties:
1640416398
operator:
@@ -17068,51 +17062,7 @@ components:
1706817062
field:
1706917063
type: string
1707017064
description: The accepted field that you want to search on.
17071-
enum:
17072-
- id
17073-
- role
17074-
- name
17075-
- avatar
17076-
- owner_id
17077-
- email
17078-
- email_domain
17079-
- phone
17080-
- external_id
17081-
- created_at
17082-
- signed_up_at
17083-
- updated_at
17084-
- last_seen_at
17085-
- last_contacted_at
17086-
- last_replied_at
17087-
- last_email_opened_at
17088-
- last_email_clicked_at
17089-
- language_override
17090-
- browser
17091-
- browser_language
17092-
- os
17093-
- location.country
17094-
- location.city
17095-
- location.region
17096-
- unsubscribed_from_emails
17097-
- marked_email_as_spam
17098-
- has_hard_bounced
17099-
- ios_last_seen_at
17100-
- ios_app_version
17101-
- ios_device
17102-
- ios_app_device
17103-
- ios_os_version
17104-
- ios_app_name
17105-
- ios_sdk_version
17106-
- android_last_seen_at
17107-
- android_app_version
17108-
- android_device
17109-
- android_app_device
17110-
- android_app_name
17111-
- android_sdk_version
17112-
- segment_id
17113-
- tag_id
17114-
- custom_attributes.*
17115-
example: custom_attributes.favorite_color
17065+
example: created_at
1711617066
operator:
1711717067
type: string
1711817068
enum:

0 commit comments

Comments
 (0)