Update Brand Glossary

curl --request PATCH \
  --url https://api.heygen.com/v3/brand-glossaries/{brand_glossary_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": null,
  "terms": null,
  "do_not_translate_terms": null,
  "forced_translations": null
}
'

import requests

url = "https://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}"

payload = {
    "name": None,
    "terms": None,
    "do_not_translate_terms": None,
    "forced_translations": None
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: null,
    terms: null,
    do_not_translate_terms: null,
    forced_translations: null
  })
};

fetch('https://api.heygen.com/v3/brand-glossaries/{brand_glossary_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://api.heygen.com/v3/brand-glossaries/{brand_glossary_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([
    'name' => null,
    'terms' => null,
    'do_not_translate_terms' => null,
    'forced_translations' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}"

	payload := strings.NewReader("{\n  \"name\": null,\n  \"terms\": null,\n  \"do_not_translate_terms\": null,\n  \"forced_translations\": null\n}")

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

	req.Header.Add("x-api-key", "<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://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": null,\n  \"terms\": null,\n  \"do_not_translate_terms\": null,\n  \"forced_translations\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": null,\n  \"terms\": null,\n  \"do_not_translate_terms\": null,\n  \"forced_translations\": null\n}"

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

{
  "data": {
    "brand_glossary_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "terms": [
      {
        "term": "<string>",
        "pronunciation": "<string>",
        "pronunciation_language": {
          "scope": "all"
        },
        "ipa": "<string>"
      }
    ],
    "do_not_translate_terms": null,
    "forced_translations": null
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Provide at least one field to update.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "ai_vendor_access_restricted",
    "message": "Workspace AI vendor policy blocks google for this request.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "resource_not_found",
    "message": "Brand glossary not found.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "conflict",
    "message": "A brand glossary with this name already exists.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "service_unavailable",
    "message": "Brand glossary access is temporarily unavailable. Please retry the request.",
    "param": null,
    "doc_url": null
  }
}