Terminology
Update terms
Terminology
Update terms
PUT
/
terminology
/
organization
/
{organizationId}
/
team
/
{teamId}
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
requiredX-Request-ID
string
Path Parameters
organizationId
integer
requiredteamId
integer
requiredBody
application/json
models
object[]
models.id
integer
requiredmodels.term
string
requiredmodels.type
enum<string>
requiredAvailable options:
approved, banned, pending models.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.caseSensitive
boolean
requiredmodels.description
string
models.highlight
boolean
models.examples
object[]
models.examples.example
string
requiredmodels.examples.type
enum<string>
requiredAvailable options:
good, bad models.mistakes
object[]
models.mistakes.reference
string
models.mistakes.mistake
string
requiredmodels.mistakes.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.mistakes.caseSensitive
boolean
requiredmodels.tags
object[]
models.tags.tag
string
requiredmodels.linkedTerms
object[]
models.linkedTerms.reference
string
models.linkedTerms.linkedTermId
integer
models.approvedTermExtension
object
models.approvedTermExtension.capitalize
boolean
requiredmodels.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.approvedTermExtension.fixCase
boolean
requiredfailHandling
enum<string>
Available options:
accumulate, validate, skip, validateOnly Response
200 - application/json
models
object[]
models.id
integer
requiredmodels.termBankId
integer
requiredmodels.term
string
requiredmodels.type
enum<string>
requiredAvailable options:
approved, banned, pending models.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.caseSensitive
boolean
requiredmodels.description
string
models.highlight
boolean
requiredmodels.creationTime
string
requiredmodels.modificationTime
string
requiredmodels.createdUser
object
requiredmodels.createdUser.id
integer
requiredmodels.createdUser.fullName
string
models.createdUser.email
string
models.modifiedUser
object
requiredmodels.modifiedUser.id
integer
requiredmodels.modifiedUser.fullName
string
models.modifiedUser.email
string
models.examples
object[]
models.examples.id
integer
models.examples.termId
integer
requiredmodels.examples.termBankId
integer
requiredmodels.examples.example
string
requiredmodels.examples.type
enum<string>
requiredAvailable options:
good, bad models.mistakes
object[]
models.mistakes.id
integer
models.mistakes.termId
integer
requiredmodels.mistakes.termBankId
integer
requiredmodels.mistakes.mistake
string
requiredmodels.mistakes.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.mistakes.caseSensitive
boolean
requiredmodels.tags
object[]
models.tags.id
integer
requiredmodels.tags.tag
string
requiredmodels.tags.termId
integer
requiredmodels.tags.parentTagId
integer
requiredmodels.linkedTerms
object[]
models.linkedTerms.id
integer
models.linkedTerms.termId
integer
requiredmodels.linkedTerms.linkedTermId
integer
requiredmodels.linkedTerms.term
string
requiredmodels.linkedTerms.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.linkedTerms.caseSensitive
boolean
requiredmodels.linkedTerms.approvedTermExtension
object
models.linkedTerms.approvedTermExtension.id
integer
models.linkedTerms.approvedTermExtension.termId
integer
requiredmodels.linkedTerms.approvedTermExtension.capitalize
boolean
requiredmodels.linkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.linkedTerms.approvedTermExtension.fixCase
boolean
requiredmodels.backlinkedTerms
object[]
models.backlinkedTerms.id
integer
models.backlinkedTerms.termId
integer
requiredmodels.backlinkedTerms.linkedTermId
integer
requiredmodels.backlinkedTerms.term
string
requiredmodels.backlinkedTerms.pos
enum<string>
Available options:
noun, verb, adverb, adjective models.backlinkedTerms.caseSensitive
boolean
requiredmodels.backlinkedTerms.approvedTermExtension
object
models.backlinkedTerms.approvedTermExtension.id
integer
models.backlinkedTerms.approvedTermExtension.termId
integer
requiredmodels.backlinkedTerms.approvedTermExtension.capitalize
boolean
requiredmodels.backlinkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.backlinkedTerms.approvedTermExtension.fixCase
boolean
requiredmodels.approvedTermExtension
object
models.approvedTermExtension.id
integer
models.approvedTermExtension.termId
integer
requiredmodels.approvedTermExtension.capitalize
boolean
requiredmodels.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.approvedTermExtension.fixCase
boolean
requiredfails
object[]
fails.description
string
requiredfails.key
string
requiredfails.extras
any
required