Skip to main content
POST
/
organization
/
fonts
Create
curl --request POST \
  --url https://api.beyondwords.io/v1/organization/fonts \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
[
  {
    "name": "My Custom Font",
    "url": "https:://example.com/my-custom-font.ttf"
  }
]
'
import requests

url = "https://api.beyondwords.io/v1/organization/fonts"

payload = [
    {
        "name": "My Custom Font",
        "url": "https:://example.com/my-custom-font.ttf"
    }
]
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{name: 'My Custom Font', url: 'https:://example.com/my-custom-font.ttf'}])
};

fetch('https://api.beyondwords.io/v1/organization/fonts', 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.beyondwords.io/v1/organization/fonts",
  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([
    [
        'name' => 'My Custom Font',
        'url' => 'https:://example.com/my-custom-font.ttf'
    ]
  ]),
  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.beyondwords.io/v1/organization/fonts"

	payload := strings.NewReader("[\n  {\n    \"name\": \"My Custom Font\",\n    \"url\": \"https:://example.com/my-custom-font.ttf\"\n  }\n]")

	req, _ := http.NewRequest("POST", 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.post("https://api.beyondwords.io/v1/organization/fonts")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"My Custom Font\",\n    \"url\": \"https:://example.com/my-custom-font.ttf\"\n  }\n]")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/organization/fonts")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"My Custom Font\",\n    \"url\": \"https:://example.com/my-custom-font.ttf\"\n  }\n]"

response = http.request(request)
puts response.read_body
[
  {
    "id": 1,
    "name": "My custom font",
    "url": "https://example.com/my-custom-font.ttf",
    "filename": null,
    "fallback": false,
    "created": "2025-01-02 23:59:59 UTC",
    "updated": "2025-01-02 23:59:59 UTC"
  }
]

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string

Name of the font. Must be unique per organization.

url
string

Temporary URL to the font (will be reuploaded to the BeyondWords cdn).

Response

201 - application/json

successful

id
integer | null

Unique identifier for the object

name
string

The name of the font

url
string | null

The url of the custom font

filename
string | null

The filename of the built-in font

fallback
boolean

Whether the font is used as a language fallback

created
string<date-time> | null

Time at which the object was created (ISO 8601)

updated
string<date-time> | null

Time at which the object was updated (ISO 8601)