Create docs for Whatsapp API messages (#275)

mailsongabriel · web-flow · commit 74562e2c49b3 · 2025-06-27T14:33:21.000+01:00
diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml
@@ -9223,7 +9223,7 @@ paths:
       - Messages
       operationId: createMessage
       description: "You can create a message that has been initiated by an admin.
-        The conversation can be either an in-app message, an email or sms.\n\n> \U0001F6A7
+        The conversation can be either an in-app message, an email, sms or whatsapp.\n\n> \U0001F6A7
         Sending for visitors\n>\n> There can be a short delay between when a contact
         is created and when a contact becomes available to be messaged through the
         API. A 404 Not Found error will be returned in this case.\n\nThis will return
@@ -9396,6 +9396,23 @@ paths:
                     id: 6762f23a1bb69f9f2193bc1a
                   message_type: sms
                   body: heyy
+              admin_whatsapp_message_created:
+                summary: admin whatsapp message created
+                value:
+                  from:
+                    type: admin
+                    id: '991267817'
+                  to:
+                    phone: +5547999998888
+                    name: John Doe
+                  message_type: whatsapp
+                  components:
+                    - type: BODY
+                      parameters:
+                        - type: text
+                          text: Username 123
+                  template: keep_live
+                  locale: en
               no_body_supplied_for_message:
                 summary: No body supplied for message
                 value:
@@ -16874,10 +16891,12 @@ components:
       properties:
         message_type:
           type: string
-          description: 'The kind of message being created. Values: `in_app` or `email`.'
+          description: 'The kind of message being created. Values: `in_app`, `email`, `sms` or `whatsapp`.'
           enum:
           - in_app
           - email
+          - sms
+          - whatsapp
           example: in_app
         subject:
           type: string
@@ -16974,6 +16993,13 @@ components:
         - body
         - from
         - to
+      - title: 'message_type: `whatsapp`.'
+        required:
+        - message_type
+        - template
+        - components
+        - from
+        - to
     recipient:
       type: object
       title: Recipient
@@ -18717,8 +18743,9 @@ components:
           - facebook
           - twitter
           - sms
-          description: The type of message that was sent. Can be email, inapp, facebook
-            ,twitter or sms.
+          - whatsapp
+          description: The type of message that was sent. Can be email, inapp, facebook,
+            twitter, sms or whatsapp.
           example: inapp
         conversation_id:
           type: string
