Skip to content

Commit defce7e

Browse files
Align Preview conversation and ticket search wording with the developer reference (#740)
Describe search date values as Unix timestamps in seconds, link the Conversation Attributes API from the update conversation description, and write "Unix timestamp" consistently in the activity log date parameters. Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 41b66d7 commit defce7e

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -194,15 +194,15 @@ paths:
194194
in: query
195195
required: true
196196
description: The start date that you request data for. It must be formatted
197-
as a UNIX timestamp.
197+
as a Unix timestamp.
198198
example: '1677253093'
199199
schema:
200200
type: string
201201
- name: created_at_before
202202
in: query
203203
required: false
204204
description: The end date that you request data for. It must be formatted
205-
as a UNIX timestamp.
205+
as a Unix timestamp.
206206
example: '1677861493'
207207
schema:
208208
type: string
@@ -300,13 +300,13 @@ paths:
300300
type: integer
301301
format: date-time
302302
description: The start date that you request data for. It must
303-
be formatted as a UNIX timestamp.
303+
be formatted as a Unix timestamp.
304304
example: 1677253093
305305
created_at_before:
306306
type: integer
307307
format: date-time
308308
description: The end date that you request data for. It must
309-
be formatted as a UNIX timestamp.
309+
be formatted as a Unix timestamp.
310310
example: 1677861493
311311
event_types:
312312
type: array
@@ -13997,7 +13997,7 @@ paths:
1399713997

1399813998
To resolve, rename or archive the duplicate attribute so each name is unique, then retry the request. You can do this through:
1399913999

14000-
- The Conversation Attributes API — list with `GET /conversations/attributes`, then rename with `PUT /conversations/attributes/{id}` or archive with `DELETE /conversations/attributes/{id}`
14000+
- The [Conversation Attributes API](/docs/references/preview/rest-api/api.intercom.io/conversations-attributes/listconversationattributes) — list with `GET /conversations/attributes`, then rename with `PUT /conversations/attributes/{id}` or archive with `DELETE /conversations/attributes/{id}`
1400114001
- Your workspace settings (Settings → Data → Conversations)
1400214002
{% /admonition %}
1400314003

@@ -14392,8 +14392,8 @@ paths:
1439214392
| Field | Type |
1439314393
| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
1439414394
| id | String |
14395-
| created_at | Date (UNIX timestamp) |
14396-
| updated_at | Date (UNIX timestamp) |
14395+
| created_at | Date (Unix timestamp in seconds) |
14396+
| updated_at | Date (Unix timestamp in seconds) |
1439714397
| source.type | String<br>Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |
1439814398
| source.id | String |
1439914399
| source.delivered_as | String |
@@ -14412,30 +14412,30 @@ paths:
1441214412
| open | Boolean |
1441314413
| read | Boolean |
1441414414
| state | String |
14415-
| waiting_since | Date (UNIX timestamp) |
14416-
| snoozed_until | Date (UNIX timestamp) |
14415+
| waiting_since | Date (Unix timestamp in seconds) |
14416+
| snoozed_until | Date (Unix timestamp in seconds) |
1441714417
| tag_ids | String |
1441814418
| priority | String |
1441914419
| statistics.time_to_assignment | Integer |
1442014420
| statistics.time_to_admin_reply | Integer |
1442114421
| statistics.time_to_first_close | Integer |
1442214422
| statistics.time_to_last_close | Integer |
1442314423
| statistics.median_time_to_reply | Integer |
14424-
| statistics.first_contact_reply_at | Date (UNIX timestamp) |
14425-
| statistics.first_assignment_at | Date (UNIX timestamp) |
14426-
| statistics.first_admin_reply_at | Date (UNIX timestamp) |
14427-
| statistics.first_close_at | Date (UNIX timestamp) |
14428-
| statistics.last_assignment_at | Date (UNIX timestamp) |
14429-
| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |
14430-
| statistics.last_contact_reply_at | Date (UNIX timestamp) |
14431-
| statistics.last_admin_reply_at | Date (UNIX timestamp) |
14432-
| statistics.last_close_at | Date (UNIX timestamp) |
14424+
| statistics.first_contact_reply_at | Date (Unix timestamp in seconds) |
14425+
| statistics.first_assignment_at | Date (Unix timestamp in seconds) |
14426+
| statistics.first_admin_reply_at | Date (Unix timestamp in seconds) |
14427+
| statistics.first_close_at | Date (Unix timestamp in seconds) |
14428+
| statistics.last_assignment_at | Date (Unix timestamp in seconds) |
14429+
| statistics.last_assignment_admin_reply_at | Date (Unix timestamp in seconds) |
14430+
| statistics.last_contact_reply_at | Date (Unix timestamp in seconds) |
14431+
| statistics.last_admin_reply_at | Date (Unix timestamp in seconds) |
14432+
| statistics.last_close_at | Date (Unix timestamp in seconds) |
1443314433
| statistics.last_closed_by_id | String |
1443414434
| statistics.count_reopens | Integer |
1443514435
| statistics.count_assignments | Integer |
1443614436
| statistics.count_conversation_parts | Integer |
14437-
| conversation_rating.requested_at | Date (UNIX timestamp) |
14438-
| conversation_rating.replied_at | Date (UNIX timestamp) |
14437+
| conversation_rating.requested_at | Date (Unix timestamp in seconds) |
14438+
| conversation_rating.replied_at | Date (Unix timestamp in seconds) |
1443914439
| conversation_rating.score | Integer |
1444014440
| conversation_rating.remark | String |
1444114441
| conversation_rating.contact_id | String |
@@ -14458,8 +14458,8 @@ paths:
1445814458
| != | All | Doesn't Equal |
1445914459
| IN | All | In Shortcut for `OR` queries Values most be in Array |
1446014460
| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |
14461-
| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |
14462-
| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |
14461+
| > | Integer Date (Unix timestamp in seconds) | Greater (or equal) than |
14462+
| < | Integer Date (Unix timestamp in seconds) | Lower (or equal) than |
1446314463
| ~ | String | Contains |
1446414464
| !~ | String | Doesn't Contain |
1446514465
| ^ | String | Starts With |
@@ -27240,8 +27240,8 @@ paths:
2724027240
| Field | Type |
2724127241
| :---------------------------------------- | :--------------------------------------------------------------------------------------- |
2724227242
| id | String |
27243-
| created_at | Date (UNIX timestamp) |
27244-
| updated_at | Date (UNIX timestamp) |
27243+
| created_at | Date (Unix timestamp in seconds) |
27244+
| updated_at | Date (Unix timestamp in seconds) |
2724527245
| title | String |
2724627246
| description | String |
2724727247
| category | String |
@@ -27252,8 +27252,8 @@ paths:
2725227252
| team_assignee_id | Integer |
2725327253
| open | Boolean |
2725427254
| state | String |
27255-
| snoozed_until | Date (UNIX timestamp) |
27256-
| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |
27255+
| snoozed_until | Date (Unix timestamp in seconds) |
27256+
| ticket_attribute.{id} | String or Boolean or Date (Unix timestamp in seconds) or Float or Integer |
2725727257

2725827258
{% admonition type="info" name="Searching by Category" %}
2725927259
When searching for tickets by the **`category`** field, specific terms must be used instead of the category names:
@@ -27276,8 +27276,8 @@ paths:
2727627276
| != | All | Doesn't Equal |
2727727277
| IN | All | In Shortcut for `OR` queries Values most be in Array |
2727827278
| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |
27279-
| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |
27280-
| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |
27279+
| > | Integer Date (Unix timestamp in seconds) | Greater (or equal) than |
27280+
| < | Integer Date (Unix timestamp in seconds) | Lower (or equal) than |
2728127281
| ~ | String | Contains |
2728227282
| !~ | String | Doesn't Contain |
2728327283
| ^ | String | Starts With |

0 commit comments

Comments
 (0)