POST
/
terminology
/
organization
/
{organizationId}
/
team
/
{teamId}
curl --request POST \
  --url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "models": [
    {
      "reference": "<string>",
      "term": "<string>",
      "type": "approved",
      "pos": "noun",
      "caseSensitive": true,
      "description": "<string>",
      "highlight": true,
      "examples": [
        {
          "example": "<string>",
          "type": "good"
        }
      ],
      "mistakes": [
        {
          "reference": "<string>",
          "mistake": "<string>",
          "pos": "noun",
          "caseSensitive": true
        }
      ],
      "tags": [
        {
          "tag": "<string>"
        }
      ],
      "linkedTerms": [
        {
          "reference": "<string>",
          "linkedTermId": 123
        }
      ],
      "approvedTermExtension": {
        "capitalize": true,
        "fixCommonMistakes": true,
        "fixCase": true
      }
    }
  ],
  "failHandling": "accumulate"
}'
{
  "models": [
    {
      "id": 123,
      "termBankId": 123,
      "term": "<string>",
      "type": "approved",
      "pos": "noun",
      "caseSensitive": true,
      "description": "<string>",
      "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>"
      },
      "examples": [
        {
          "id": 123,
          "termId": 123,
          "termBankId": 123,
          "example": "<string>",
          "type": "good"
        }
      ],
      "mistakes": [
        {
          "id": 123,
          "termId": 123,
          "termBankId": 123,
          "mistake": "<string>",
          "pos": "noun",
          "caseSensitive": true
        }
      ],
      "tags": [
        {
          "id": 123,
          "tag": "<string>",
          "termId": 123,
          "parentTagId": 123
        }
      ],
      "linkedTerms": [
        {
          "id": 123,
          "termId": 123,
          "linkedTermId": 123,
          "term": "<string>",
          "pos": "noun",
          "caseSensitive": true,
          "approvedTermExtension": {
            "id": 123,
            "termId": 123,
            "capitalize": true,
            "fixCommonMistakes": true,
            "fixCase": true
          }
        }
      ],
      "backlinkedTerms": [
        {
          "id": 123,
          "termId": 123,
          "linkedTermId": 123,
          "term": "<string>",
          "pos": "noun",
          "caseSensitive": true,
          "approvedTermExtension": {
            "id": 123,
            "termId": 123,
            "capitalize": true,
            "fixCommonMistakes": true,
            "fixCase": true
          }
        }
      ],
      "approvedTermExtension": {
        "id": 123,
        "termId": 123,
        "capitalize": true,
        "fixCommonMistakes": true,
        "fixCase": true
      }
    }
  ],
  "fails": [
    {
      "description": "<string>",
      "key": "<string>",
      "extras": "<any>"
    }
  ]
}

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

Path Parameters

​
organizationId
integer
required
​
teamId
integer
required

Body

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

Response

200
application/json
​
models
object[]
​
fails
object[]

Was this page helpful?

Page detailsDelete terms