Skip to content

Add PATCH /data_connectors/:id to OpenAPI spec#427

Merged
ellicenelson merged 3 commits intomainfrom
ellicenelson/add-update-data-connector-endpoint
Mar 27, 2026
Merged

Add PATCH /data_connectors/:id to OpenAPI spec#427
ellicenelson merged 3 commits intomainfrom
ellicenelson/add-update-data-connector-endpoint

Conversation

@ellicenelson
Copy link
Copy Markdown
Contributor

@ellicenelson ellicenelson commented Mar 27, 2026

Why?

API consumers need documentation for the new update endpoint so they can programmatically update their data connector configurations.

How?

Adds the PATCH endpoint definition and update_data_connector_request schema to the Unstable version spec. Field descriptions mirror the existing data_connector_detail schema for consistency. Also fixes "publish" phrasing to "set to live" in the create endpoint description. Removes the changelog file to follow existing convention (changelog lives in developer-docs, not here).

Related

  • intercom/intercom#489076
  • intercom/developer-docs#803

Generated with Claude Code

Copy link
Copy Markdown
Contributor

@levindixon levindixon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Spec changes, request schema, and error examples are clean and consistent with the existing endpoints. One small suggestion:

Missing "Invalid state" 422 example

The 422 section covers invalid audiences and invalid http_method, but not an invalid state value. Since state is the most consequential field on this endpoint, consider adding:

Invalid state:
  value:
    type: error.list
    request_id: a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d
    errors:
    - code: parameter_invalid
      message: "Invalid state. Must be one of: draft, live"

Not a blocker — approving as-is.

@ellicenelson ellicenelson merged commit 99025e8 into main Mar 27, 2026
3 checks passed
@ellicenelson ellicenelson deleted the ellicenelson/add-update-data-connector-endpoint branch March 27, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants