---
title: "Update an existing relationship"
method: PATCH
path: "/api/rest/v1/catalog/{id}/relationships/{relationshipId}"
tags: ["Relationships"]
---

# Update an existing relationship

`PATCH /api/rest/v1/catalog/{id}/relationships/{relationshipId}`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/catalog/{id}/relationships/{relationshipId}`
- Auth: none required

## Path parameters

- `id` string, uuid, required
- `relationshipId` string, uuid, required

## Request body

- UpdateRelationshipRequest: Update relationship request body.
  - `description` string, nullable

## Response `200`

OK

- RestApiResponseOfCatalogRelationshipItem: Standard REST API response envelope for a single resource.
  - `data` CatalogRelationshipItem, required: Catalog relationship item for list and detail responses.
    - `id` string, uuid, required
    - `relationshipKindId` string, uuid, required
    - `relationshipKindKey` string, nullable, required
    - `sourceEntityId` string, uuid, required
    - `targetEntityId` string, uuid, required
    - `description` string, nullable, required
    - `source` string, required
    - `confidence` union, required
      - number, double
      - string, double
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)