Skip to main content
PATCH
/
api2
/
v1
/
termBases
/
customFields
/
{id}
Edit TB custom field
curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v1/termBases/customFields/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldName": "Usage notes",
  "values": [
    "<string>"
  ]
}
'
import requests

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

payload = {
"fieldName": "Usage notes",
"values": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({fieldName: 'Usage notes', values: ['<string>']})
};

fetch('https://cloud.memsource.com/web/api2/v1/termBases/customFields/{id}', 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/customFields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fieldName' => 'Usage notes',
'values' => [
'<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/customFields/{id}"

payload := strings.NewReader("{\n \"fieldName\": \"Usage notes\",\n \"values\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://cloud.memsource.com/web/api2/v1/termBases/customFields/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldName\": \"Usage notes\",\n \"values\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldName\": \"Usage notes\",\n \"values\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "fieldName": "<string>",
  "id": "<string>",
  "level": "TERM",
  "type": "SINGLE_SELECT",
  "values": [
    "<string>"
  ]
}

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

id
string
required

Body

application/json

DTO for editing a term base custom field

fieldName
string
required

Name of the custom field

Required string length: 1 - 100
Pattern: .*\S.*
Example:

"Usage notes"

values
string[]

Possible values for select type fields. Required for type SINGLE_SELECT and MULTI_SELECT

Maximum array length: 100

Response

successful operation

DTO representing a term base custom field

fieldName
string

Name of the custom field

id
string

Unique identifier of the custom field

level
enum<string>

Level of the custom field

Available options:
TERM,
CONCEPT
Example:

"TERM"

type
enum<string>

Type of the custom field

Available options:
STRING,
NUMBER,
DATE,
BOOLEAN,
SINGLE_SELECT,
MULTI_SELECT,
URL
Example:

"SINGLE_SELECT"

values
string[]

List of possible values for select type fields