Document GET /data_connectors/{id} - missing show endpoint (rebased on main)

Author: salmanbshah

descriptions/0/api.intercom.io.yaml

@@ -8465,6 +8465,144 @@ paths:
                   type: admin
                   admin_id: 991267717
                   body: Goodbye :)
+  "/conversations/{conversation_id}/conversation_parts/{id}":
+    put:
+      summary: Update a conversation part
+      parameters:
+      - name: Intercom-Version
+        in: header
+        schema:
+          "$ref": "#/components/schemas/intercom_version"
+      - name: conversation_id
+        in: path
+        required: true
+        description: The identifier for the conversation as given by Intercom.
+        example: '123'
+        schema:
+          type: string
+      - name: id
+        in: path
+        required: true
+        description: The identifier for the conversation part.
+        example: '456'
+        schema:
+          type: string
+      tags:
+      - Conversations
+      operationId: updateConversationPart
+      description: |
+        You can update properties of a conversation part. Currently supports updating the send state of an external reply or marking a part as seen by an admin.
+
+        {% admonition type="warning" name="Experimental" %}
+          This is an experimental endpoint. It requires a valid HMAC secret for authentication in addition to the standard bearer token.
+        {% /admonition %}
+      responses:
+        '200':
+          description: Conversation part updated
+          content:
+            application/json:
+              examples:
+                Update send state:
+                  value:
+                    type: conversation_part
+                    id: '456'
+                    part_type: comment
+                    body: "<p>Hello there!</p>"
+                    created_at: 1734537559
+                    updated_at: 1734537561
+                    notified_at: 1734537559
+                    assigned_to:
+                    author:
+                      id: '991267694'
+                      type: admin
+                      name: Ciaran Lee
+                      email: admin@email.com
+                    attachments: []
+                    external_id:
+                    external_reply_send_state: sent
+                Mark part as seen:
+                  value:
+                    type: conversation_part
+                    id: '456'
+                    part_type: comment
+                    body: "<p>Hello there!</p>"
+                    created_at: 1734537559
+                    updated_at: 1734537561
+                    notified_at: 1734537559
+                    assigned_to:
+                    author:
+                      id: '991267694'
+                      type: admin
+                      name: Ciaran Lee
+                      email: admin@email.com
+                    attachments: []
+                    external_id:
+                    seen_state:
+                      admin_seen: true
+              schema:
+                "$ref": "#/components/schemas/conversation_part"
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              examples:
+                Unauthorized:
+                  value:
+                    type: error.list
+                    request_id: a3e5b8e2-1234-5678-9abc-def012345678
+                    errors:
+                    - code: unauthorized
+                      message: Access Token Invalid
+              schema:
+                "$ref": "#/components/schemas/error"
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              examples:
+                Forbidden:
+                  value:
+                    type: error.list
+                    request_id: b4f6c9d3-2345-6789-abcd-ef0123456789
+                    errors:
+                    - code: forbidden
+                      message: Forbidden request
+              schema:
+                "$ref": "#/components/schemas/error"
+        '404':
+          description: Conversation part not found
+          content:
+            application/json:
+              examples:
+                Conversation part not found:
+                  value:
+                    type: error.list
+                    request_id: c5a7d0e4-3456-789a-bcde-f01234567890
+                    errors:
+                    - code: not_found
+                      message: Resource Not Found
+              schema:
+                "$ref": "#/components/schemas/error"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/update_conversation_part_request"
+            examples:
+              update_send_state:
+                summary: Update send state
+                value:
+                  send_state: sent
+                  info_message: Message delivered successfully
+                  experimental: true
+                  secret: hmac_secret_value
+              mark_as_seen:
+                summary: Mark part as seen
+                value:
+                  seen: true
+                  admin_id: '991267694'
+                  experimental: true
+                  secret: hmac_secret_value
   "/conversations/{id}/customers":
     post:
       summary: Attach a contact to a conversation
@@ -11774,6 +11912,98 @@ paths:
                     message: "Request failed due to an internal error. Please reach out to support"
               schema:
                 "$ref": "#/components/schemas/error"
+  "/messages/whatsapp/status":
+    get:
+      summary: Retrieve WhatsApp message delivery status
+      parameters:
+      - name: Intercom-Version
+        in: header
+        schema:
+          "$ref": "#/components/schemas/intercom_version"
+      - name: message_id
+        in: query
+        required: true
+        description: The WhatsApp message ID to check status for
+        schema:
+          type: string
+      tags:
+      - Messages
+      - WhatsApp
+      operationId: RetrieveWhatsAppMessageStatus
+      description: |
+        Retrieves the delivery status of a specific WhatsApp message by its message ID.
+
+
+        Returns the current status, conversation details, and any error information if the message failed to deliver.
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              examples:
+                Successful response:
+                  value:
+                    conversation_id: "123456789"
+                    status: delivered
+                    type: broadcast_outbound
+                    created_at: 1734537980
+                    updated_at: 1734538000
+                    template_name: appointment_reminder
+                    message_id: "wamid_abc123"
+                Failed message with error:
+                  value:
+                    conversation_id: "123456789"
+                    status: failed
+                    type: broadcast_outbound
+                    created_at: 1734537980
+                    updated_at: 1734538000
+                    template_name: appointment_reminder
+                    message_id: "wamid_abc123"
+                    error:
+                      message: "Message delivery failed"
+                      details: "Recipient phone number not on WhatsApp"
+              schema:
+                "$ref": "#/components/schemas/whatsapp_message_status"
+        '400':
+          description: Bad request - missing required parameters
+          content:
+            application/json:
+              examples:
+                missing message_id:
+                  value:
+                    type: error
+                    request_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+                    message: "message_id is required"
+              schema:
+                "$ref": "#/components/schemas/error"
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              examples:
+                Unauthorized:
+                  value:
+                    type: error.list
+                    request_id: 8b2e4c6f-1234-5678-9abc-def012345678
+                    errors:
+                    - code: unauthorized
+                      message: Access Token Invalid
+              schema:
+                "$ref": "#/components/schemas/error"
+        '404':
+          description: WhatsApp message not found
+          content:
+            application/json:
+              examples:
+                Message not found:
+                  value:
+                    type: error.list
+                    request_id: c4d5e6f7-8901-2345-6789-abcdef012345
+                    errors:
+                    - code: whatsapp_message_not_found
+                      message: Whatsapp message not found
+              schema:
+                "$ref": "#/components/schemas/error"
   "/news/news_items":
     get:
       summary: List all news items
@@ -16509,6 +16739,44 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/error"
+  "/fin_voice/conversation/{conversation_id}":
+    get:
+      summary: Collect Fin Voice calls by conversation ID
+      description: |
+        Retrieve information about Fin Voice calls associated with a conversation.
+
+        Returns all matched calls for the given conversation ID. A conversation may have multiple associated calls.
+      operationId: collectFinVoiceCallsByConversationId
+      tags:
+        - Calls
+      parameters:
+        - name: conversation_id
+          in: path
+          required: true
+          description: The Intercom conversation identifier
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ai_call_response"
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/error"
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/error"
 components:
   schemas:
     datetime:
@@ -23337,6 +23605,50 @@ components:
               template_name:
                 type: string
                 description: Name of the WhatsApp template used
+    whatsapp_message_status:
+      type: object
+      description: The delivery status of a specific WhatsApp message.
+      properties:
+        conversation_id:
+          type: string
+          description: ID of the conversation
+          example: "123456789"
+        status:
+          type: string
+          description: Current delivery status of the message
+          enum: ["sent", "delivered", "read", "failed"]
+          example: delivered
+        type:
+          type: string
+          description: Event type
+          example: broadcast_outbound
+        created_at:
+          type: integer
+          description: Creation timestamp
+          example: 1734537980
+        updated_at:
+          type: integer
+          description: Last update timestamp
+          example: 1734538000
+        template_name:
+          type: string
+          description: Name of the WhatsApp template used
+          example: appointment_reminder
+        message_id:
+          type: string
+          description: The WhatsApp message ID
+          example: "wamid_abc123"
+        error:
+          type: object
+          nullable: true
+          description: Error details, present only when status is "failed"
+          properties:
+            message:
+              type: string
+              description: Error message
+            details:
+              type: string
+              description: Detailed error information
     multiple_filter_search_request:
       title: Multiple Filter Search Request
       description: Search using Intercoms Search APIs with more than one filter.
@@ -23805,6 +24117,42 @@ components:
       required:
       - text
       - uuid
+    update_conversation_part_request:
+      title: Update Conversation Part Request
+      type: object
+      description: |
+        Payload for updating a conversation part. Supports two operations:
+        1. Updating the send state of an external reply (requires `send_state` and `info_message`).
+        2. Marking a part as seen by an admin (requires `seen` and `admin_id`).
+        Both operations require `experimental` and `secret` for HMAC authentication.
+      properties:
+        send_state:
+          type: string
+          description: The send state to set on the external reply.
+          example: sent
+        info_message:
+          type: string
+          description: An informational message about the send state update.
+          example: Message delivered successfully
+        seen:
+          type: boolean
+          description: Set to true to mark the conversation part as seen.
+          example: true
+        admin_id:
+          type: string
+          description: The id of the admin marking the part as seen.
+          example: '991267694'
+        experimental:
+          type: boolean
+          description: Must be true to use this experimental endpoint.
+          example: true
+        secret:
+          type: string
+          description: HMAC secret for authenticating the experimental request.
+          example: hmac_secret_value
+      required:
+      - experimental
+      - secret
     redact_conversation_request:
       oneOf:
       - title: Redact Conversation Part Request

descriptions/0/changelog.md

@@ -1,2 +1,5 @@
 ## `GET /data_connectors/{id}` added
 Added missing show endpoint for retrieving a single data connector by ID.
+
+## `GET /messages/whatsapp/status` added
+Added missing endpoint for checking WhatsApp message delivery status.