You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: descriptions/2.11/api.intercom.io.yaml
+15-65Lines changed: 15 additions & 65 deletions
Original file line number
Diff line number
Diff line change
@@ -1363,7 +1363,7 @@ paths:
1363
1363
1364
1364
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.
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.
1368
1368
{% /admonition %}
1369
1369
responses:
@@ -1666,7 +1666,7 @@ paths:
1666
1666
description: |
1667
1667
You can update a single company using the Intercom provisioned `id`.
When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
1671
1671
{% /admonition %}
1672
1672
responses:
@@ -3716,6 +3716,7 @@ paths:
3716
3716
| email | String |
3717
3717
| email_domain | String |
3718
3718
| phone | String |
3719
+
| formatted_phone | String |
3719
3720
| external_id | String |
3720
3721
| created_at | Date (UNIX Timestamp) |
3721
3722
| signed_up_at | Date (UNIX Timestamp) |
@@ -3753,7 +3754,7 @@ paths:
3753
3754
3754
3755
### Accepted Operators
3755
3756
3756
-
{% admonition type="warning" name="Searching based on `created_at`" %}
3757
+
{% admonition type="attention" name="Searching based on `created_at`" %}
3757
3758
You cannot use the `<=` or `>=` operators to search by `created_at`.
3758
3759
{% /admonition %}
3759
3760
@@ -4877,7 +4878,7 @@ paths:
4877
4878
4878
4879
### Accepted Fields
4879
4880
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"`).
4881
4882
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.
4882
4883
4883
4884
| Field | Type |
@@ -5815,11 +5816,8 @@ paths:
5815
5816
- Conversations
5816
5817
operationId: autoAssignConversation
5817
5818
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 %}
5821
5819
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" %}
5823
5821
It is not possible to use this endpoint with Workflows.
5824
5822
{% /admonition %}
5825
5823
responses:
@@ -5968,7 +5966,7 @@ paths:
5968
5966
description: |+
5969
5967
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
5970
5968
5971
-
{% admonition type="warning" name="Contacts without an email" %}
5969
+
{% admonition type="attention" name="Contacts without an email" %}
5972
5970
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`.
5973
5971
{% /admonition %}
5974
5972
@@ -6073,7 +6071,7 @@ paths:
6073
6071
description: |+
6074
6072
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
6075
6073
6076
-
{% admonition type="warning" name="Contacts without an email" %}
6074
+
{% admonition type="attention" name="Contacts without an email" %}
6077
6075
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`.
6078
6076
{% /admonition %}
6079
6077
@@ -10339,15 +10337,14 @@ paths:
10339
10337
### Accepted Fields
10340
10338
10341
10339
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.
0 commit comments