Skip to main content
PUT
/
terminology
/
organization
/
{organizationId}
/
team
/
{teamId}
Update terms
curl --request PUT \
  --url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "models": [
    {
      "id": 123,
      "term": "<string>",
      "caseSensitive": true,
      "description": "<string>",
      "highlight": true,
      "examples": [
        {
          "example": "<string>"
        }
      ],
      "mistakes": [
        {
          "mistake": "<string>",
          "caseSensitive": true,
          "reference": "<string>"
        }
      ],
      "tags": [
        {
          "tag": "<string>"
        }
      ],
      "linkedTerms": [
        {
          "reference": "<string>",
          "linkedTermId": 123
        }
      ]
    }
  ]
}
'
import requests

url = "https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId}"

payload = { "models": [
{
"id": 123,
"term": "<string>",
"caseSensitive": True,
"description": "<string>",
"highlight": True,
"examples": [{ "example": "<string>" }],
"mistakes": [
{
"mistake": "<string>",
"caseSensitive": True,
"reference": "<string>"
}
],
"tags": [{ "tag": "<string>" }],
"linkedTerms": [
{
"reference": "<string>",
"linkedTermId": 123
}
]
}
] }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
models: [
{
id: 123,
term: '<string>',
caseSensitive: true,
description: '<string>',
highlight: true,
examples: [{example: '<string>'}],
mistakes: [{mistake: '<string>', caseSensitive: true, reference: '<string>'}],
tags: [{tag: '<string>'}],
linkedTerms: [{reference: '<string>', linkedTermId: 123}]
}
]
})
};

fetch('https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "models": [
    {
      "id": 123,
      "termBankId": 123,
      "term": "<string>",
      "caseSensitive": true,
      "highlight": true,
      "creationTime": "2023-11-07T05:31:56Z",
      "modificationTime": "2023-11-07T05:31:56Z",
      "createdUser": {
        "id": 123,
        "fullName": "<string>",
        "email": "<string>"
      },
      "modifiedUser": {
        "id": 123,
        "fullName": "<string>",
        "email": "<string>"
      },
      "description": "<string>",
      "examples": [
        {
          "termId": 123,
          "termBankId": 123,
          "example": "<string>",
          "id": 123
        }
      ],
      "mistakes": [
        {
          "termId": 123,
          "termBankId": 123,
          "mistake": "<string>",
          "caseSensitive": true,
          "id": 123
        }
      ],
      "tags": [
        {
          "id": 123,
          "tag": "<string>",
          "termId": 123,
          "parentTagId": 123
        }
      ],
      "linkedTerms": [
        {
          "termId": 123,
          "linkedTermId": 123,
          "term": "<string>",
          "caseSensitive": true,
          "id": 123,
          "approvedTermExtension": {
            "termId": 123,
            "capitalize": true,
            "fixCommonMistakes": true,
            "fixCase": true,
            "id": 123
          }
        }
      ],
      "backlinkedTerms": [
        {
          "termId": 123,
          "linkedTermId": 123,
          "term": "<string>",
          "caseSensitive": true,
          "id": 123,
          "approvedTermExtension": {
            "termId": 123,
            "capitalize": true,
            "fixCommonMistakes": true,
            "fixCase": true,
            "id": 123
          }
        }
      ],
      "approvedTermExtension": {
        "termId": 123,
        "capitalize": true,
        "fixCommonMistakes": true,
        "fixCase": true,
        "id": 123
      }
    }
  ],
  "fails": [
    {
      "description": "<string>",
      "key": "<string>",
      "extras": "<unknown>"
    }
  ]
}
{
"tpe": "<string>",
"extras": "<unknown>",
"errors": [
{
"description": "<string>",
"key": "<string>",
"extras": "<unknown>"
}
]
}
{
"tpe": "<string>",
"extras": "<unknown>",
"errors": [
{
"description": "<string>",
"key": "<string>",
"extras": "<unknown>"
}
]
}
{
"tpe": "<string>",
"extras": "<unknown>",
"errors": [
{
"description": "<string>",
"key": "<string>",
"extras": "<unknown>"
}
]
}
{
"tpe": "<string>",
"extras": "<unknown>",
"errors": [
{
"description": "<string>",
"key": "<string>",
"extras": "<unknown>"
}
]
}
{
"tpe": "<string>",
"extras": "<unknown>",
"errors": [
{
"description": "<string>",
"key": "<string>",
"extras": "<unknown>"
}
]
}
We’re deprecating these API endpoints, so the AI Studio API key setup won’t work. [Contact support] (https://support.writer.com/) if you need them.

Headers

Authorization
string
required
X-Request-ID
string

Path Parameters

organizationId
integer<int64>
required
teamId
integer<int64>
required

Body

application/json
models
object[]
failHandling
enum<string>
Available options:
accumulate,
validate,
skip,
validateOnly

Response

models
object[]
fails
object[]