Create term

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lang": "<string>",
  "text": "<string>",
  "allowDuplicate": true,
  "caseSensitive": true,
  "conceptId": "<string>",
  "customFields": [
    {
      "fieldName": "<string>",
      "value": {}
    }
  ],
  "exactMatch": true,
  "forbidden": true,
  "note": "<string>",
  "preferred": true,
  "shortTranslation": "<string>",
  "usage": "<string>"
}
'

import requests

url = "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms"

payload = {
    "lang": "<string>",
    "text": "<string>",
    "allowDuplicate": True,
    "caseSensitive": True,
    "conceptId": "<string>",
    "customFields": [
        {
            "fieldName": "<string>",
            "value": {}
        }
    ],
    "exactMatch": True,
    "forbidden": True,
    "note": "<string>",
    "preferred": True,
    "shortTranslation": "<string>",
    "usage": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lang: '<string>',
    text: '<string>',
    allowDuplicate: true,
    caseSensitive: true,
    conceptId: '<string>',
    customFields: [{fieldName: '<string>', value: {}}],
    exactMatch: true,
    forbidden: true,
    note: '<string>',
    preferred: true,
    shortTranslation: '<string>',
    usage: '<string>'
  })
};

fetch('https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lang' => '<string>',
    'text' => '<string>',
    'allowDuplicate' => true,
    'caseSensitive' => true,
    'conceptId' => '<string>',
    'customFields' => [
        [
                'fieldName' => '<string>',
                'value' => [
                                
                ]
        ]
    ],
    'exactMatch' => true,
    'forbidden' => true,
    'note' => '<string>',
    'preferred' => true,
    'shortTranslation' => '<string>',
    'usage' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms"

	payload := strings.NewReader("{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "text": "<string>",
  "caseSensitive": true,
  "conceptId": "<string>",
  "conceptNote": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "role": "SYS_ADMIN",
    "uid": "<string>",
    "userName": "<string>"
  },
  "customFields": [
    {
      "fieldName": "<string>",
      "value": {}
    }
  ],
  "definition": "<string>",
  "domain": "<string>",
  "exactMatch": true,
  "forbidden": true,
  "gender": "<string>",
  "id": "<string>",
  "lang": "<string>",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "role": "SYS_ADMIN",
    "uid": "<string>",
    "userName": "<string>"
  },
  "note": "<string>",
  "number": "<string>",
  "partOfSpeech": "<string>",
  "preferred": true,
  "rtl": true,
  "shortTranslation": "<string>",
  "status": "New",
  "subDomains": [
    "<string>"
  ],
  "termType": "<string>",
  "url": "<string>",
  "usage": "<string>",
  "writable": true
}

Term Base

Create term

Set conceptId to assign the term to an existing concept, otherwise a new concept will be created. Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base’s project. A LINGUIST can always create a term with status New; creating a term with status Approved additionally requires the user’s editAllTermsInTB right. This is distinct from the account-level rights gating the term base resource itself (see createTermBase/updateTermBase/deleteTermBase). Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rather than also allowing GUEST/LINGUIST users assigned to the term base’s project. When termBaseUid refers to a glossary, term creation is additionally subject to the glossary’s term-count limit and fails once that limit is exceeded.

POST

api2

termBases

{termBaseUid}

terms

Create term

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lang": "<string>",
  "text": "<string>",
  "allowDuplicate": true,
  "caseSensitive": true,
  "conceptId": "<string>",
  "customFields": [
    {
      "fieldName": "<string>",
      "value": {}
    }
  ],
  "exactMatch": true,
  "forbidden": true,
  "note": "<string>",
  "preferred": true,
  "shortTranslation": "<string>",
  "usage": "<string>"
}
'

import requests

url = "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms"

payload = {
    "lang": "<string>",
    "text": "<string>",
    "allowDuplicate": True,
    "caseSensitive": True,
    "conceptId": "<string>",
    "customFields": [
        {
            "fieldName": "<string>",
            "value": {}
        }
    ],
    "exactMatch": True,
    "forbidden": True,
    "note": "<string>",
    "preferred": True,
    "shortTranslation": "<string>",
    "usage": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lang: '<string>',
    text: '<string>',
    allowDuplicate: true,
    caseSensitive: true,
    conceptId: '<string>',
    customFields: [{fieldName: '<string>', value: {}}],
    exactMatch: true,
    forbidden: true,
    note: '<string>',
    preferred: true,
    shortTranslation: '<string>',
    usage: '<string>'
  })
};

fetch('https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lang' => '<string>',
    'text' => '<string>',
    'allowDuplicate' => true,
    'caseSensitive' => true,
    'conceptId' => '<string>',
    'customFields' => [
        [
                'fieldName' => '<string>',
                'value' => [
                                
                ]
        ]
    ],
    'exactMatch' => true,
    'forbidden' => true,
    'note' => '<string>',
    'preferred' => true,
    'shortTranslation' => '<string>',
    'usage' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms"

	payload := strings.NewReader("{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/termBases/{termBaseUid}/terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lang\": \"<string>\",\n  \"text\": \"<string>\",\n  \"allowDuplicate\": true,\n  \"caseSensitive\": true,\n  \"conceptId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"exactMatch\": true,\n  \"forbidden\": true,\n  \"note\": \"<string>\",\n  \"preferred\": true,\n  \"shortTranslation\": \"<string>\",\n  \"usage\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "text": "<string>",
  "caseSensitive": true,
  "conceptId": "<string>",
  "conceptNote": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "role": "SYS_ADMIN",
    "uid": "<string>",
    "userName": "<string>"
  },
  "customFields": [
    {
      "fieldName": "<string>",
      "value": {}
    }
  ],
  "definition": "<string>",
  "domain": "<string>",
  "exactMatch": true,
  "forbidden": true,
  "gender": "<string>",
  "id": "<string>",
  "lang": "<string>",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "role": "SYS_ADMIN",
    "uid": "<string>",
    "userName": "<string>"
  },
  "note": "<string>",
  "number": "<string>",
  "partOfSpeech": "<string>",
  "preferred": true,
  "rtl": true,
  "shortTranslation": "<string>",
  "status": "New",
  "subDomains": [
    "<string>"
  ],
  "termType": "<string>",
  "url": "<string>",
  "usage": "<string>",
  "writable": true
}

Authorizations

Authorization

string

header

required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

termBaseUid

string

required

Term base UID

Body

application/json

lang

string

required

text

string

required

allowDuplicate

boolean

Default: true. Set to false to get a duplicate warning instead of creating the term.

caseSensitive

boolean

Default: false

conceptId

string

customFields

object[]

Show child attributes

exactMatch

boolean

Default: false

forbidden

boolean

Default: false

gender

enum<string>

Available options:

MASCULINE,

FEMININE,

NEUTRAL

note

string

number

enum<string>

Available options:

SINGULAR,

PLURAL,

UNCOUNTABLE

partOfSpeech

enum<string>

Available options:

ADJECTIVE,

NOUN,

VERB,

ADVERB

preferred

boolean

Default: false

shortTranslation

string

status

enum<string>

Available options:

New,

Approved

termType

enum<string>

Available options:

FULL_FORM,

SHORT_FORM,

ACRONYM,

ABBREVIATION,

PHRASE,

VARIANT

usage

string

Response

Created

text

string

required

caseSensitive

boolean

conceptId

string

conceptNote

string

createdAt

string<date-time>

createdBy

object

Show child attributes

customFields

object[]

Show child attributes

definition

string

domain

string

exactMatch

boolean

forbidden

boolean

gender

string

lang

string

modifiedAt

string<date-time>

modifiedBy

object

Show child attributes

note

string

number

string

partOfSpeech

string

preferred

boolean

rtl

boolean

shortTranslation

string

status

enum<string>

Available options:

New,

Approved

subDomains

string[]

termType

string

url

string

usage

string

writable

boolean

⌘I

Guides

API Documentation

Create term

Authorizations

Path Parameters

Body

Response