---
title: "Update a link"
method: PATCH
path: "/external-links/{linkId}"
tags: ["External Links"]
---

# Update a link

`PATCH /external-links/{linkId}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/external-links/{linkId}`
- Auth: none declared

Updates a link.

## Path parameters

- `linkId` string, required

## Request body

- object
  - `updates` ExternalLinksLinkIdPatchRequestBodyContentApplicationJsonSchemaUpdates
    - `name` string
    - `address` string
    - `description` string

## Response `200`

The output of the link update.

- ExternalLinksUpdateLinkResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.
  - `data` IapLinksSchema: This is the schema for an IAP external link stored in Mongo
    - `name` string, required
    - `address` string, required
    - `description` string
    - `_meta` IapLinksSchemaMeta
      - `created` string
      - `updated` string

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `External Links` added
  - api tag `externalLinks` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/external-links/:linkId/patch.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)