---
title: "Patch Source"
method: PATCH
path: "/sources/{id}"
---

# Patch Source

`PATCH /sources/{id}`

Patches metadata associated with a source in the Isometric system.

## Path parameters

- `id` string, required

## Headers

- `x-client-secret` string, required — A secret token identifying the client connecting to the API

## Request body

- PatchSourceRequest
  - `supplier_reference_id` union
    - string — A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `display_name` union
    - string
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `description` union
    - string — A description of the source document. Must be at most 2000 characters long.
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `published_at` union
    - string, date — Date in ISO format (YYYY-MM-DD)
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
  - `is_public` union — If the source document should be publicly available on the Registry once credits are issued.
    - boolean
    - Undefined — An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.
      - `__typename` 'Undefined' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.

## Response `200`

Successful Response

- Source
  - `id` string, required
  - `supplier_reference_id` string, nullable, required — A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.
  - `display_name` string, nullable, required
  - `description` string, nullable, required
  - `original_filename` string, nullable, required
  - `type` 'DOCUMENT' | 'WEBSITE', required
  - `published_at` string, date, nullable, required
  - `url_info` union, required — URL info for the source, that varies depending on if it is public or private
    - SourcePublicUrlInfo
      - `__typename` 'SourcePublicUrlInfo' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
      - `url` string, required
    - SourcePrivateUrlInfo
      - `__typename` 'SourcePrivateUrlInfo' — Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.
      - `is_accessible` boolean, required — This field indicates whether or not a private source visible to the caller. If it is, to get a temporary pre-signed url that will allow the caller to view the source, make a request to the "/sources/{id}/private_url" endpoint.
  - `is_public` boolean, required — This field indicates Whether or not this source document will be public on the Registry once Credits are issued referencing it.
  - `project_id` string, nullable, required — The ID of the project that the source is associated with.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api.md) · [All operations](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/isometric/isometric-certify-data-ingestion-api/versions/9819e9c8ccf0/schema)