You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add PATCH /data_connectors/:id to OpenAPI spec (#427)
* feat: Add update endpoint for data connectors with request body schema
* chore: Remove changelog entries for open API
* feat: Add error handling for invalid state in data connector endpoint
Copy file name to clipboardExpand all lines: descriptions/0/api.intercom.io.yaml
+261-1Lines changed: 261 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10553,7 +10553,7 @@ paths:
10553
10553
- Data Connectors
10554
10554
operationId: createDataConnector
10555
10555
description: |
10556
-
Create a new data connector. The connector is created in `draft` state. Configure its URL, headers, data inputs, and other settings, then publish it to `live` when ready.
10556
+
Create a new data connector. The connector is created in `draft` state. Configure its URL, headers, data inputs, and other settings, then set it to `live` when ready.
10557
10557
responses:
10558
10558
'201':
10559
10559
description: Data connector created
@@ -10864,6 +10864,156 @@ paths:
10864
10864
message: Access Token Invalid
10865
10865
schema:
10866
10866
"$ref": "#/components/schemas/error"
10867
+
patch:
10868
+
summary: Update a data connector
10869
+
parameters:
10870
+
- name: Intercom-Version
10871
+
in: header
10872
+
schema:
10873
+
"$ref": "#/components/schemas/intercom_version"
10874
+
- name: id
10875
+
in: path
10876
+
required: true
10877
+
description: The unique identifier of the data connector.
10878
+
example: '12345'
10879
+
schema:
10880
+
type: string
10881
+
tags:
10882
+
- Data Connectors
10883
+
operationId: updateDataConnector
10884
+
description: |
10885
+
Update an existing data connector. Only provided fields are changed. Set `state` to `live` or `draft` to change the connector's state.
summary: List execution results for a data connector
@@ -22485,6 +22635,116 @@ components:
22485
22635
example: false
22486
22636
required:
22487
22637
- name
22638
+
update_data_connector_request:
22639
+
title: Update Data Connector Request
22640
+
type: object
22641
+
description: |
22642
+
Update an existing data connector. All fields are optional — only provided fields will be updated. Set `state` to `live` or `draft` to change the connector's state.
22643
+
properties:
22644
+
name:
22645
+
type: string
22646
+
description: The name of the data connector.
22647
+
example: Updated Connector Name
22648
+
description:
22649
+
type: string
22650
+
description: A description of what this data connector does.
22651
+
example: Updated description
22652
+
state:
22653
+
type: string
22654
+
description: The desired state of the connector.
22655
+
enum:
22656
+
- draft
22657
+
- live
22658
+
http_method:
22659
+
type: string
22660
+
description: The HTTP method used by the data connector.
22661
+
enum:
22662
+
- get
22663
+
- post
22664
+
- put
22665
+
- delete
22666
+
- patch
22667
+
example: post
22668
+
url:
22669
+
type: string
22670
+
description: The URL of the external API endpoint. Supports template variables like `{{order_id}}`.
0 commit comments