CRcrowdin
Glossaries

Edit Term

Required scopes: glossary (Read and Write).

Updates the term with a JSON Patch document. Only the paths listed in the request schema can be replaced.

Note: A replace on /fields writes the whole set of custom field values — a field the value omits, or whose value is empty, is cleared

patch/glossaries/{glossaryId}/terms/{termId}

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

termIdinteger required

Term Identifier. Get via List Terms

Request body

op'replace' | 'test' required

Patch operation to perform

path'/text' | '/description' | '/partOfSpeech' | '/status' | '/type' | '/gender' | '/url' | '/note' | '/fields' json-pointer required

A JSON Pointer as defined by RFC 6901

Response

Term was successfully updated

Example response

{
  "data": {
    "id": 2,
    "userId": 6,
    "glossaryId": 6,
    "languageId": "fr",
    "text": "Voir",
    "description": "use for pages only (check screenshots)",
    "partOfSpeech": "verb",
    "status": "preferred",
    "type": "abbreviation",
    "gender": "masculine",
    "note": "Any kind of note, such as a usage note, explanation, or instruction",
    "url": "Base URL",
    "conceptId": 6,
    "lemma": "voir",
    "createdAt": "2019-09-23T07:19:47+00:00",
    "updatedAt": "2019-09-23T07:19:47+00:00",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.