Patch Sink

Partially update a sink.

patch/api/v1/stream/{stream_id}/sink/{sink_id}

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

sink_idstring required

The StreamSink's ID or UID.

Example:unique-identifier

The StreamSink's ID or UID.

Request body

Example request

{
  "batchSize": 100,
  "channels": [
    "project_1337"
  ],
  "eventTypes": [
    "user.signup"
  ],
  "uid": "unique-identifier"
}

Response

Example response

{
  "channels": [
    "project_1337"
  ],
  "eventTypes": [
    "user.signup"
  ],
  "id": "sink_2yZwUhtgs5Ai8T9yRQJXA",
  "uid": "unique-identifier"
}

Changes

Changed in 4 of the 6 revisions of this API.717

Sep 2, 2026267f7078e53624See the full diff
- ▲
  the response property oneOf[StreamSinkOut_amazonS3]/config/accessKeyId became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property oneOf[StreamSinkOut_amazonS3]/config/accessKeyId became optional for the status 200
  response-property-became-optional
- ○
  added the new optional request property oneOf[StreamSinkPatch_amazonS3]/config/externalId
  new-optional-request-property
- ○
  added the new optional request property oneOf[StreamSinkPatch_amazonS3]/config/roleArn
  new-optional-request-property
- ○
  added the optional property oneOf[StreamSinkOut_amazonS3]/config/externalId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[StreamSinkOut_amazonS3]/config/roleArn to the response with the 200 status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 28, 202650dde67d2d2d13See the full diff
- ▲
  added StreamSinkOut_postgres to the response body oneOf list for the response status 200
  response-body-one-of-added
- ○
  added postgres mapping keys to the request discriminator
  request-body-discriminator-mapping-added
- ○
  added StreamSinkPatch_postgres to the request body oneOf list
  request-body-one-of-added
- ○
  added postgres mapping keys to the response discriminator for the response status 200
  response-body-discriminator-mapping-added
Aug 19, 2026dc130bd1b07426See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 from the request body oneOf list
  request-body-one-of-removed
- ▲
  added StreamSinkOut_poller StreamSinkOut_azureBlobStorage StreamSinkOut_otelTracing StreamSinkOut_http StreamSinkOut_amazonS3 StreamSinkOut_snowflake StreamSinkOut_googleCloudStorage StreamSinkOut_googleCloudPubSub StreamSinkOut_redshift StreamSinkOut_bigQuery StreamSinkOut_clickhouse StreamSinkOut_rabbitMq StreamSinkOut_sqs StreamSinkOut_eventBridge StreamSinkOut_sns to the response body oneOf list for the response status 200
  response-body-one-of-added
- ○
  added the new optional request property channels
  new-optional-request-property
- ○
  added request discriminator
  request-body-discriminator-added
- ○
  added StreamSinkPatch_poller StreamSinkPatch_azureBlobStorage StreamSinkPatch_otelTracing StreamSinkPatch_http StreamSinkPatch_amazonS3 StreamSinkPatch_googleCloudStorage StreamSinkPatch_googleCloudPubSub StreamSinkPatch_sqs StreamSinkPatch_sns StreamSinkPatch_bigQuery StreamSinkPatch_clickhouse StreamSinkPatch_eventBridge StreamSinkPatch_snowflake StreamSinkPatch_rabbitMq StreamSinkPatch_redshift to the request body oneOf list
  request-body-one-of-added
- ○
  added response discriminator for the response status 200
  response-body-discriminator-added
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 from the response body oneOf list for the response status 200
  response-body-one-of-removed
- ○
  added the optional property channels to the response with the 200 status
  response-optional-property-added
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 202616dbcc056c4824See the full diff
- ▲
  removed StreamSinkPatch_poller StreamSinkPatch_azureBlobStorage StreamSinkPatch_otelTracing StreamSinkPatch_http StreamSinkPatch_amazonS3 StreamSinkPatch_googleCloudStorage StreamSinkPatch_googleCloudPubSub StreamSinkPatch_sqs StreamSinkPatch_sns StreamSinkPatch_bigQuery StreamSinkPatch_clickhouse StreamSinkPatch_eventBridge StreamSinkPatch_snowflake StreamSinkPatch_rabbitMq StreamSinkPatch_redshift from the request body oneOf list
  request-body-one-of-removed
- ▲
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 to the response body oneOf list for the response status 200
  response-body-one-of-added
- ○
  removed request discriminator
  request-body-discriminator-removed
- ○
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 to the request body oneOf list
  request-body-one-of-added
- ○
  removed response discriminator for the response status 200
  response-body-discriminator-removed
- ○
  removed StreamSinkOut_poller StreamSinkOut_azureBlobStorage StreamSinkOut_otelTracing StreamSinkOut_http StreamSinkOut_amazonS3 StreamSinkOut_googleCloudStorage StreamSinkOut_googleCloudPubSub StreamSinkOut_sqs StreamSinkOut_sns StreamSinkOut_bigQuery StreamSinkOut_clickhouse StreamSinkOut_eventBridge StreamSinkOut_snowflake StreamSinkOut_rabbitMq StreamSinkOut_redshift from the response body oneOf list for the response status 200
  response-body-one-of-removed
This revision also has 157 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history