---
title: "Update a glossary entry by ID"
method: PATCH
path: "/api/glossaries/{glossaryId}/relationships/entries/{id}"
tags: ["Glossaries"]
---

# Update a glossary entry by ID

`PATCH /api/glossaries/{glossaryId}/relationships/entries/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/glossaries/{glossaryId}/relationships/entries/{id}`
- Auth: API key in header `X-API-KEY`

Update a glossary entry by its ID.

## Path parameters

- `glossaryId` string, uuid, required
- `id` string, uuid, required

## Request body

- RequestGlossaryEntryUpdateResource
  - `data` GlossaryEntryUpdateResource, required
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` GlossaryEntryUpdateResourceAttributes, required
      - `term` string, nullable, required
      - `definition` string, nullable, required
      - `status` 'ACTIVE' | 'INACTIVE', required
      - `synonyms` string[], nullable, required
      - `relatedTerms` ResourceIdentifier[], nullable, required
        - `type` string, required: Identifies the type of the linked resource.
        - `id` string, required: The unique identifier of the linked resource.
    - `relationships` GlossaryEntryUpdateResourceRelationships, required
      - `relatedTerms` MultipleRelationshipsUpdate, required
        - `data` ResourceIdentifier[], required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `restoreVersion` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.

## Response `200`

The updated glossary entry

- SingleResourceBodyGlossaryEntryResource
  - `data` GlossaryEntryResource
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` GlossaryEntryResourceAttributes, required
      - `term` string, required
      - `definition` string, required
      - `status` string, required
      - `synonyms` string[], nullable, required
      - `meta` GlossaryEntryResourceMetadata, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `updatedBy` string, nullable, required
    - `meta` GlossaryEntryResourceMetadata, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `updatedBy` string, nullable, required
    - `relationships` GlossaryEntryResourceRelationships, required
      - `updatedBy` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `relatedTerms` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

## Other responses

- `400`: Id in the path and in the body do not match
- `404`: Glossary entry not found
- `500`: Unexpected error

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)