Update department
Updates a department. This is a partial update: only the properties present in the body are changed. Setting parentId moves the department, together with its sub-departments, under another department; null or an empty parentId moves it back to top level under the organization’s root department. The organization’s root department can be renamed and given a vatType, but not moved. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the department does not exist or belongs to a different organization, or when parentId is cleared and the organization has no valid root department configured.
curl --request PUT \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Marketing & Communications",
"parentId": "b41d20cf417a4c41a273588bac7c1ffc"
}
'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
payload = {
"name": "Marketing & Communications",
"parentId": "b41d20cf417a4c41a273588bac7c1ffc"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Marketing & Communications',
parentId: 'b41d20cf417a4c41a273588bac7c1ffc'
})
};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}', 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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}",
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' => 'Marketing & Communications',
'parentId' => 'b41d20cf417a4c41a273588bac7c1ffc'
]),
CURLOPT_HTTPHEADER => [
"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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
payload := strings.NewReader("{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.
"11adfe2a080040e3892ffb89c21ec44e"
String. The ID of the department to update, as returned in the id field of the response. Lookup by externalSourceId is not supported for departments, unlike organizationId.
"9360d03ad7294220868d67f42a2a144d"
Body
Partial update: only the properties present in the body are changed, the rest are left unchanged. Any other property, such as id, level or customDimensionPresetValues from a GET response, is ignored, so a department returned by GET can be modified and sent back as is. All properties are optional.
Optional. String, maximum 255 characters. Display name of the department. When present, it must be non-empty and not whitespace-only. Leading and trailing whitespace is trimmed.
255Optional. String or null, maximum 255 characters. External source identifier, for example the department's ID in an integrated system. Leading and trailing whitespace is trimmed. Null or an empty value clears it.
255Optional. String or null. The id of the department to move this one under. It must be a department in the same organization, and not this department or one of its descendants. The department's sub-departments move with it, and vatType is left unchanged by a move. Null or an empty value moves the department back to top level, directly under the organization's root department. The organization's root department cannot be moved: a non-empty value on it is rejected, while null or an empty value is ignored.
Optional. String or null, one of USE_CATEGORY, NON_DEDUCTABLE_VAT or DEDUCTABLE_VAT. VAT deduction handling for this department, case-sensitive. Applies to this department only: it is not inherited from the parent or passed on to sub-departments. Null or an empty value resets it to USE_CATEGORY.
USE_CATEGORY, NON_DEDUCTABLE_VAT, DEDUCTABLE_VAT, null Response
OK — returns the updated department
Unique identifier of the department.
External source identifier of the department, if set by an integration. Null when not set.
Display name of the department.
The id of the parent department. Null only for the organization's own root unit (level 0). Every other department, including a top-level one directly under the root, has this set to its parent's id.
VAT deduction handling for this department. Defaults to USE_CATEGORY when not explicitly set.
USE_CATEGORY, NON_DEDUCTABLE_VAT, DEDUCTABLE_VAT Preset custom dimension values configured for this department, in the order they were created. The order is stable, so identical requests return the values in the same order. Excludes values belonging to deleted dimension definitions.
Hide child attributes
Hide child attributes
Unique identifier of the preset value.
The ID of the custom dimension definition this preset value belongs to.
The ID of the selected list value, when the dimension uses a list of values. Null when a free-text preset is used instead.
Display text of the selected list value. Null when a free-text preset is used instead.
Free-text preset value, when the dimension does not use a list of values. Null when a list value is used instead.
Depth of the department within the organization's unit hierarchy. The organization's implicit root unit is level 0; a genuine top-level department is level 1.
curl --request PUT \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Marketing & Communications",
"parentId": "b41d20cf417a4c41a273588bac7c1ffc"
}
'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
payload = {
"name": "Marketing & Communications",
"parentId": "b41d20cf417a4c41a273588bac7c1ffc"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Marketing & Communications',
parentId: 'b41d20cf417a4c41a273588bac7c1ffc'
})
};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}', 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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}",
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' => 'Marketing & Communications',
'parentId' => 'b41d20cf417a4c41a273588bac7c1ffc'
]),
CURLOPT_HTTPHEADER => [
"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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
payload := strings.NewReader("{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Marketing & Communications\",\n \"parentId\": \"b41d20cf417a4c41a273588bac7c1ffc\"\n}"
response = http.request(request)
puts response.read_body