---
title: "Update a source"
method: PUT
path: "/v1/projects/{projectID}/sources/{sourceID}"
tags: ["Sources"]
---

# Update a source

`PUT /v1/projects/{projectID}/sources/{sourceID}`

This endpoint updates a source

## Path parameters

- `projectID` string, required
- `sourceID` string, required

## Request body

- ModelsUpdateSource
  - `custom_response` ModelsUpdateCustomResponse
    - `body` string
    - `content_type` string
  - `forward_headers` string[]
  - `idempotency_keys` string[]
  - `is_disabled` boolean
  - `name` string
  - `pub_sub` ModelsPubSubConfig
    - `google` ModelsGooglePubSubConfig
      - `project_id` string
      - `service_account` integer[]
      - `subscription_id` string
    - `kafka` ModelsKafkaPubSubConfig
      - `auth` ModelsKafkaAuth
        - `hash` string
        - `password` string
        - `tls` boolean
        - `type` string
        - `username` string
      - `brokers` string[]
      - `consumer_group_id` string
      - `topic_name` string
    - `sqs` ModelsSQSPubSubConfig
      - `access_key_id` string
      - `default_region` string
      - `queue_name` string
      - `secret_key` string
    - `type` 'sqs' | 'google' | 'kafka'
    - `workers` integer
  - `type` 'http' | 'rest_api' | 'pub_sub' | 'db_change_stream'
  - `verifier` ModelsVerifierConfig
    - `api_key` ModelsApiKey
      - `header_name` string
      - `header_value` string
    - `basic_auth` ModelsBasicAuth
      - `password` string
      - `username` string
    - `hmac` ModelsHMac
      - `encoding` 'base64' | 'hex'
      - `hash` string
      - `header` string
      - `secret` string
    - `type` 'noop' | 'hmac' | 'basic_auth' | 'api_key'

## Changes

- **2023-11-27** (v3) `47c7286b8cee` — 1 warning
  - removed the request property `idempotency_ttl`
- **2023-11-17** (v3) `41d4fca4cab8` — 1 warning, 3 info
  - added the new `kafka` enum value to the `allOf[subschema #2]/data/pub_sub/type` response property for the response status `200`
  - added the new optional request property `pub_sub/kafka`
  - added the new `kafka` enum value to the request property `pub_sub/type`
  - added the optional property `allOf[subschema #2]/data/pub_sub/kafka` to the response with the `200` status
- **2023-07-28** (v3) `2fc887538896` — 1 warning
  - removed the optional property `allOf[subschema #2]/data/idempotency_ttl` from the response with the `200` status
- **2023-06-22** (v3) `5c862889f0b4` — 4 info
  - added the new optional request property `idempotency_keys`
  - added the new optional request property `idempotency_ttl`
  - added the optional property `allOf[subschema #2]/data/idempotency_keys` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/idempotency_ttl` to the response with the `200` status

[Change history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/sources/:sourceID/put.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/52443da83eda/schema)