Replace a taxonomy

curl --request PUT \
  --url https://{host}/lucca-api/taxonomies/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "T-shirt size",
  "t9n": {
    "name": {
      "fr-FR": "Taille de t-shirt."
    }
  }
}
'

import requests

url = "https://{host}/lucca-api/taxonomies/{id}"

payload = {
    "name": "T-shirt size",
    "t9n": { "name": { "fr-FR": "Taille de t-shirt." } }
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'T-shirt size', t9n: {name: {'fr-FR': 'Taille de t-shirt.'}}})
};

fetch('https://{host}/lucca-api/taxonomies/{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://{host}/lucca-api/taxonomies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'T-shirt size',
    't9n' => [
        'name' => [
                'fr-FR' => 'Taille de t-shirt.'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "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://{host}/lucca-api/taxonomies/{id}"

	payload := strings.NewReader("{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}")

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

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://{host}/lucca-api/taxonomies/{id}")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/taxonomies/{id}")

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

request = Net::HTTP::Put.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}"

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

{
  "id": "45",
  "type": "taxonomy",
  "url": "https://example.ilucca.net/lucca-api/taxonomies/45",
  "name": "T-shirt size",
  "createdAt": "2025-01-23T19:45:23Z",
  "lastUpdatedAt": "2025-01-23T19:45:23Z",
  "t9n": {
    "name": {
      "fr-FR": "Taille de t-shirt."
    }
  },
  "links": {},
  "embedded": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

PUT

lucca-api

taxonomies

{id}

Replace a taxonomy

curl --request PUT \
  --url https://{host}/lucca-api/taxonomies/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "T-shirt size",
  "t9n": {
    "name": {
      "fr-FR": "Taille de t-shirt."
    }
  }
}
'

import requests

url = "https://{host}/lucca-api/taxonomies/{id}"

payload = {
    "name": "T-shirt size",
    "t9n": { "name": { "fr-FR": "Taille de t-shirt." } }
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'T-shirt size', t9n: {name: {'fr-FR': 'Taille de t-shirt.'}}})
};

fetch('https://{host}/lucca-api/taxonomies/{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://{host}/lucca-api/taxonomies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'T-shirt size',
    't9n' => [
        'name' => [
                'fr-FR' => 'Taille de t-shirt.'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "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://{host}/lucca-api/taxonomies/{id}"

	payload := strings.NewReader("{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}")

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

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://{host}/lucca-api/taxonomies/{id}")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/taxonomies/{id}")

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

request = Net::HTTP::Put.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"T-shirt size\",\n  \"t9n\": {\n    \"name\": {\n      \"fr-FR\": \"Taille de t-shirt.\"\n    }\n  }\n}"

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

{
  "id": "45",
  "type": "taxonomy",
  "url": "https://example.ilucca.net/lucca-api/taxonomies/45",
  "name": "T-shirt size",
  "createdAt": "2025-01-23T19:45:23Z",
  "lastUpdatedAt": "2025-01-23T19:45:23Z",
  "t9n": {
    "name": {
      "fr-FR": "Taille de t-shirt."
    }
  },
  "links": {},
  "embedded": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.

Access

OAuth 2.0 scopes

 taxonomies.readwrite

 employee-attribute-definitions.readwrite

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Path Parameters

string

required

Identifier of the taxonomy

Minimum string length: 1

Query Parameters

include

enum<string>[]

Include metadata:

embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Body

application/json

Representation of an taxonomy.

The full representation of the taxonomy.

name

string

required

Minimum string length: 1

sortLabelsBy

enum<string>

default:id

Indication to the client about how it should sort taxonomy-labels. Value can be interpolated as the expected value of the "sort" query parameter: /lucca-api/taxonomy-labels?taxonomy.id={{taxonomy.id}}&sort={{taxonomy.sortLabelsBy}}

Available options:

id,

name

t9n

object

Show child attributes

Response

The updated taxonomy resource.

name

string

required

Minimum string length: 1

string

Minimum string length: 1

type

string

Allowed value: "taxonomy"

url

string<uri>

sortLabelsBy

enum<string>

default:id

Available options:

id,

name

createdAt

string<date-time>

Read-only. UTC timestamp of the moment this object was created. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

t9n

object

Show child attributes

links

object

embedded

object | null

No embedded resources on a taxonomy(ies) response. Expect an empty object if embedded are requested.

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

Replace a taxonomy

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response