Skip to content

Commit d42d1e8

Browse files
Align translations on conversation, ticket and ticket reply parts in Preview
Declare the original key on every translations map, stop marking it as required (it is omitted when the source locale is unknown), note that the field is available from API version 2.16, and use French in every example. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent c49d18d commit d42d1e8

1 file changed

Lines changed: 49 additions & 39 deletions

File tree

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

Lines changed: 49 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -15204,6 +15204,10 @@ paths:
1520415204
metadata: {}
1520515205
email_message_metadata:
1520615206
app_package_code: null
15207+
translations:
15208+
original: en
15209+
en: "<p>Goodbye :)</p>"
15210+
fr: "<p>Au revoir :)</p>"
1520715211
total_count: 1
1520815212
Snooze a conversation:
1520915213
value:
@@ -36144,21 +36148,23 @@ components:
3614436148
type: object
3614536149
nullable: true
3614636150
description: >-
36147-
A map of the reply text keyed by locale code. Only present on the
36148-
Preview API version and backs the `conversation.admin.replied.translated`
36149-
webhook topic. The special `original` key holds the source locale code
36150-
of the reply; every other key is a locale code whose value is the reply
36151-
text translated into that locale, as HTML in the same format as `body`.
36152-
The `body` field is unchanged and always
36153-
stays in the original source language. Available in the Preview API version
36154-
only (set `Intercom-Version: Preview`). This webhook topic is not sent for
36155-
every translated reply: it is suppressed when the reply's `body` contains
36156-
any text outside an HTML block element, which includes plain-text replies
36157-
created through the REST API.
36151+
A map of the reply text keyed by locale code, with values in the
36152+
same format as `body` (HTML by default). Backs the
36153+
`conversation.admin.replied.translated` webhook topic. The special
36154+
`original` key holds the source locale code of the reply when it is
36155+
known; every other key is a locale code whose value is the reply text
36156+
translated into that locale. The `translations` field does not modify
36157+
`body`. Available from API version 2.16.
36158+
This webhook topic is not sent for every translated reply: it is
36159+
suppressed when the reply's `body` contains any text outside an HTML block
36160+
element, which includes plain-text replies created through the REST API.
3615836161
Wrap the body in `<p>`, `<div>`, or another supported block element to
3615936162
avoid this.
36160-
required:
36161-
- original
36163+
properties:
36164+
original:
36165+
type: string
36166+
description: The locale code identifying the language the reply was originally written in.
36167+
example: en
3616236168
additionalProperties:
3616336169
type: string
3616436170
example:
@@ -45044,21 +45050,23 @@ components:
4504445050
type: object
4504545051
nullable: true
4504645052
description: >-
45047-
A map of the reply text keyed by locale code. Only present on the
45048-
Preview API version and backs the `ticket.admin.replied.translated`
45049-
webhook topic. The special `original` key holds the source locale code
45050-
of the reply; every other key is a locale code whose value is the reply
45051-
text translated into that locale, as HTML in the same format as `body`.
45052-
The `body` field is unchanged and always
45053-
stays in the original source language. Available in the Preview API version
45054-
only (set `Intercom-Version: Preview`). This webhook topic is not sent for
45055-
every translated reply: it is suppressed when the reply's `body` contains
45056-
any text outside an HTML block element, which includes plain-text replies
45057-
created through the REST API.
45053+
A map of the reply text keyed by locale code, with values in the
45054+
same format as `body` (HTML by default). Backs the
45055+
`ticket.admin.replied.translated` webhook topic. The special
45056+
`original` key holds the source locale code of the reply when it is
45057+
known; every other key is a locale code whose value is the reply text
45058+
translated into that locale. The `translations` field does not modify
45059+
`body`. Available from API version 2.16.
45060+
This webhook topic is not sent for every translated reply: it is
45061+
suppressed when the reply's `body` contains any text outside an HTML block
45062+
element, which includes plain-text replies created through the REST API.
4505845063
Wrap the body in `<p>`, `<div>`, or another supported block element to
4505945064
avoid this.
45060-
required:
45061-
- original
45065+
properties:
45066+
original:
45067+
type: string
45068+
description: The locale code identifying the language the reply was originally written in.
45069+
example: en
4506245070
additionalProperties:
4506345071
type: string
4506445072
example:
@@ -45238,21 +45246,23 @@ components:
4523845246
type: object
4523945247
nullable: true
4524045248
description: >-
45241-
A map of the reply text keyed by locale code. Only present on the
45242-
Preview API version and backs the `ticket.admin.replied.translated`
45243-
webhook topic. The special `original` key holds the source locale code
45244-
of the reply; every other key is a locale code whose value is the reply
45245-
text translated into that locale, as HTML in the same format as `body`.
45246-
The `body` field is unchanged and always
45247-
stays in the original source language. Available in the Preview API version
45248-
only (set `Intercom-Version: Preview`). This webhook topic is not sent for
45249-
every translated reply: it is suppressed when the reply's `body` contains
45250-
any text outside an HTML block element, which includes plain-text replies
45251-
created through the REST API.
45249+
A map of the reply text keyed by locale code, with values in the
45250+
same format as `body` (HTML by default). Backs the
45251+
`ticket.admin.replied.translated` webhook topic. The special
45252+
`original` key holds the source locale code of the reply when it is
45253+
known; every other key is a locale code whose value is the reply text
45254+
translated into that locale. The `translations` field does not modify
45255+
`body`. Available from API version 2.16.
45256+
This webhook topic is not sent for every translated reply: it is
45257+
suppressed when the reply's `body` contains any text outside an HTML block
45258+
element, which includes plain-text replies created through the REST API.
4525245259
Wrap the body in `<p>`, `<div>`, or another supported block element to
4525345260
avoid this.
45254-
required:
45255-
- original
45261+
properties:
45262+
original:
45263+
type: string
45264+
description: The locale code identifying the language the reply was originally written in.
45265+
example: en
4525645266
additionalProperties:
4525745267
type: string
4525845268
example:

0 commit comments

Comments
 (0)