Skip to content

Commit 9bce0d1

Browse files
Updating Messages documentation (#212)
1 parent 8a5af84 commit 9bce0d1

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8477,7 +8477,7 @@ paths:
84778477
- Messages
84788478
operationId: createMessage
84798479
description: "You can create a message that has been initiated by an admin.
8480-
The conversation can be either an in-app message or an email.\n\n> \U0001F6A7
8480+
The conversation can be either an in-app message, an email or sms.\n\n> \U0001F6A7
84818481
Sending for visitors\n>\n> There can be a short delay between when a contact
84828482
is created and when a contact becomes available to be messaged through the
84838483
API. A 404 Not Found error will be returned in this case.\n\nThis will return
@@ -8543,6 +8543,13 @@ paths:
85438543
errors:
85448544
- code: parameter_invalid
85458545
message: Body is required
8546+
Invalid body supplied for sms message:
8547+
value:
8548+
type: error.list
8549+
request_id: d7997515-65af-4860-9bf5-777852f8b24f
8550+
errors:
8551+
- code: parameter_invalid
8552+
message: Invalid SMS message body
85468553
schema:
85478554
"$ref": "#/components/schemas/error"
85488555
'422':
@@ -8620,6 +8627,17 @@ paths:
86208627
id: 6762f2391bb69f9f2193bc19
86218628
message_type: conversation
86228629
body: heyy
8630+
admin_sms_message_created:
8631+
summary: admin sms message created
8632+
value:
8633+
from:
8634+
type: admin
8635+
id: '991267817'
8636+
to:
8637+
type: user
8638+
id: 6762f23a1bb69f9f2193bc1a
8639+
message_type: sms
8640+
body: heyy
86238641
no_body_supplied_for_message:
86248642
summary: No body supplied for message
86258643
value:
@@ -8655,6 +8673,17 @@ paths:
86558673
message_type: email
86568674
body:
86578675
subject: heyy
8676+
invalid_body_supplied_for_sms_message:
8677+
summary: Invalid body supplied for sms message
8678+
value:
8679+
from:
8680+
type: admin
8681+
id: '991267821'
8682+
to:
8683+
type: user
8684+
id: 6762f23b1bb69f9f2193bc1d
8685+
message_type: sms
8686+
body: heyy https://picsum.photos/200/300
86588687
"/news/news_items":
86598688
get:
86608689
summary: List all news items
@@ -15773,10 +15802,11 @@ components:
1577315802
properties:
1577415803
message_type:
1577515804
type: string
15776-
description: 'The kind of message being created. Values: `in_app` or `email`.'
15805+
description: 'The kind of message being created. Values: `in_app`, `email` or `sms`.'
1577715806
enum:
1577815807
- in_app
1577915808
- email
15809+
- sms
1578015810
example: in_app
1578115811
subject:
1578215812
type: string
@@ -15854,6 +15884,12 @@ components:
1585415884
- body
1585515885
- from
1585615886
- to
15887+
- title: 'message_type: `sms`.'
15888+
required:
15889+
- message_type
15890+
- body
15891+
- from
15892+
- to
1585715893
create_or_update_company_request:
1585815894
type: object
1585915895
title: Create Or Update Company Request Payload
@@ -17417,8 +17453,9 @@ components:
1741717453
- inapp
1741817454
- facebook
1741917455
- twitter
17456+
- sms
1742017457
description: The type of message that was sent. Can be email, inapp, facebook
17421-
or twitter.
17458+
,twitter or sms.
1742217459
example: inapp
1742317460
conversation_id:
1742417461
type: string

0 commit comments

Comments
 (0)