---
title: "Patch Ingest Source"
method: PATCH
path: "/ingest/api/v1/source/{source_id}"
tags: ["Ingest Source"]
---

# Patch Ingest Source

`PATCH /ingest/api/v1/source/{source_id}`

Patch an Ingest Source.

## Path parameters

- `source_id` string, required — The Source's ID or UID.

## Request body

- IngestSourcePatch
  - `name` string
  - `uid` string, nullable — The Source's UID.
  - `metadata` object

## Response `200`

- union
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'generic-webhook', required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'cron', required
    - `config` CronConfig, required
      - `schedule` string, required
      - `payload` string, required
      - `contentType` string, nullable — Override the default content-type. Recommended if the payload is not JSON.
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'adobe-sign', required
    - `config` AdobeSignConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'beehiiv', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'brex', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'checkbook', required
    - `config` CheckbookConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'clerk', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'docusign', required
    - `config` DocusignConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'easypost', required
    - `config` EasypostConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'github', required
    - `config` GithubConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'guesty', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'hubspot', required
    - `config` HubspotConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'incident-io', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'lithic', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'meta', required
    - `config` MetaConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'nango', required
    - `config` NangoConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'nash', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'openclaw', required
    - `config` OpenClawConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'orum-io', required
    - `config` OrumIoConfigOut, required
      - `publicKey` string, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'panda-doc', required
    - `config` PandaDocConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'port-io', required
    - `config` PortIoConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'psi-fi', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'pleo', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'replicate', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'resend', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'rutter', required
    - `config` RutterConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'safebase', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'sardine', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'segment', required
    - `config` SegmentConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'shopify', required
    - `config` ShopifyConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'slack', required
    - `config` SlackConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'stripe', required
    - `config` StripeConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'stych', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'svix', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'zoom', required
    - `config` ZoomConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'tailscale', required
    - `config` TailscaleConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'telnyx', required
    - `config` TelnyxConfigOut, required
      - `publicKey` string, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'vapi', required
    - `config` VapiConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'open-ai', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'render', required
    - `config` SvixConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'veriff', required
    - `config` VeriffConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'airwallex', required
    - `config` AirwallexConfigOut, required
  - object
    - `id` string, required — The Source's ID.
    - `uid` string, nullable — The Source's UID.
    - `name` string, required
    - `ingestUrl` string, uri, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `metadata` object, required
    - `type` 'vgs', required
    - `config` VgsConfigOut, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Validation Error
- `429` — Too Many Requests

---

[API](https://skmtc.net/svix/apis/svix-api.md) · [All operations](https://skmtc.net/svix/apis/svix-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/svix/svix-api/versions/16dbcc056c48/schema)