cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/field_settings/item" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"field_settings": {
"item": {
"fields": [
{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false"
}
]
}
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_field_settings_item(
{
"field_settings": {
"item": {
"fields": [
{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false",
}
]
}
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsFieldSettingsItem({
field_settings: {item: {fields: [{name: 'barcodeValue', module: 'item', enabled: 'true', required: 'false'}]}},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsFieldSettingsItem([
'field_settings' => [
'item' => [
'fields' => [
[
'name' => 'barcodeValue',
'module' => 'item',
'enabled' => 'true',
'required' => 'false',
],
],
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsFieldSettingsItem;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsFieldSettingsItem> response = client.settings().updateSettingsFieldSettingsItem(
Map.of(
"field_settings", Map.of(
"item", Map.of(
"fields", List.of(
Map.of(
"name", "barcodeValue",
"module", "item",
"enabled", "true",
"required", "false"))))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsFieldSettingsItemAsync(new Dictionary<string, object?>
{
["field_settings"] = new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["fields"] = new List<object?>
{
new Dictionary<string, object?>
{
["name"] = "barcodeValue",
["module"] = "item",
["enabled"] = "true",
["required"] = "false",
},
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsFieldSettingsItem({
'field_settings': {
'item': {
'fields': [
{
'name': 'barcodeValue',
'module': 'item',
'enabled': 'true',
'required': 'false',
},
],
},
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Settings().UpdateSettingsFieldSettingsItem(context.Background(), map[string]any{
"field_settings": map[string]any{
"item": map[string]any{
"fields": []any{
map[string]any{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false",
},
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"created_by": "<unknown>",
"created_on": "<string>",
"description": "<unknown>",
"display_code": "<string>",
"editable": "<unknown>",
"enabled": true,
"entity": "<string>",
"field_name": "<string>",
"field_type": "<string>",
"global_search": true,
"group_key": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"mandatory": true,
"note": "<unknown>",
"object": "<string>",
"sort_order": 123
}
],
"general_settings": {
"account": {
"account_grouping": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"account_management": {
"default_manager": "<unknown>",
"enabled": "<string>"
},
"additional_contact_1": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_1": "<string>",
"type": "<string>"
},
"additional_contact_2": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_2": "<string>",
"type": "<string>"
},
"additional_contact_3": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_3": "<string>",
"type": "<string>"
},
"billing_contact": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_billing_contact": "<string>",
"type": "<string>"
},
"creation_of_subsidiary_account": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"enable_workflow_approval_for_account": "<string>",
"referral_tracking_at_account_level": {
"default_referral_tracking": "<unknown>",
"enabled": "<string>"
},
"require_email_address_for_account": "<string>",
"require_name_to_be_unique": "<string>",
"sales_rep_tracking_at_account_level": {
"default_sales_rep_tracking": "<unknown>",
"enabled": "<string>"
},
"send_communication_as_groups": "<string>",
"shipping_contact": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_shipping_contact": "<string>",
"type": "<string>"
},
"unique_email_address_for_account": "<string>",
"unique_email_address_for_contacts": "<string>"
}
},
"message": "<string>",
"object": "<string>",
"pagination": "<unknown>",
"url": "<string>"
}Instance settings
Update item field settings
Turns item fields on or off, or makes them required, and returns the field settings.
PATCH
/
settings
/
field_settings
/
item
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/field_settings/item" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"field_settings": {
"item": {
"fields": [
{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false"
}
]
}
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_field_settings_item(
{
"field_settings": {
"item": {
"fields": [
{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false",
}
]
}
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsFieldSettingsItem({
field_settings: {item: {fields: [{name: 'barcodeValue', module: 'item', enabled: 'true', required: 'false'}]}},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsFieldSettingsItem([
'field_settings' => [
'item' => [
'fields' => [
[
'name' => 'barcodeValue',
'module' => 'item',
'enabled' => 'true',
'required' => 'false',
],
],
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsFieldSettingsItem;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsFieldSettingsItem> response = client.settings().updateSettingsFieldSettingsItem(
Map.of(
"field_settings", Map.of(
"item", Map.of(
"fields", List.of(
Map.of(
"name", "barcodeValue",
"module", "item",
"enabled", "true",
"required", "false"))))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsFieldSettingsItemAsync(new Dictionary<string, object?>
{
["field_settings"] = new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["fields"] = new List<object?>
{
new Dictionary<string, object?>
{
["name"] = "barcodeValue",
["module"] = "item",
["enabled"] = "true",
["required"] = "false",
},
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsFieldSettingsItem({
'field_settings': {
'item': {
'fields': [
{
'name': 'barcodeValue',
'module': 'item',
'enabled': 'true',
'required': 'false',
},
],
},
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Settings().UpdateSettingsFieldSettingsItem(context.Background(), map[string]any{
"field_settings": map[string]any{
"item": map[string]any{
"fields": []any{
map[string]any{
"name": "barcodeValue",
"module": "item",
"enabled": "true",
"required": "false",
},
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"created_by": "<unknown>",
"created_on": "<string>",
"description": "<unknown>",
"display_code": "<string>",
"editable": "<unknown>",
"enabled": true,
"entity": "<string>",
"field_name": "<string>",
"field_type": "<string>",
"global_search": true,
"group_key": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"mandatory": true,
"note": "<unknown>",
"object": "<string>",
"sort_order": 123
}
],
"general_settings": {
"account": {
"account_grouping": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"account_management": {
"default_manager": "<unknown>",
"enabled": "<string>"
},
"additional_contact_1": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_1": "<string>",
"type": "<string>"
},
"additional_contact_2": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_2": "<string>",
"type": "<string>"
},
"additional_contact_3": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_additional_contact_3": "<string>",
"type": "<string>"
},
"billing_contact": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_billing_contact": "<string>",
"type": "<string>"
},
"creation_of_subsidiary_account": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"enable_workflow_approval_for_account": "<string>",
"referral_tracking_at_account_level": {
"default_referral_tracking": "<unknown>",
"enabled": "<string>"
},
"require_email_address_for_account": "<string>",
"require_name_to_be_unique": "<string>",
"sales_rep_tracking_at_account_level": {
"default_sales_rep_tracking": "<unknown>",
"enabled": "<string>"
},
"send_communication_as_groups": "<string>",
"shipping_contact": {
"display_name": "<string>",
"enabled": "<string>",
"require_email_address_for_shipping_contact": "<string>",
"type": "<string>"
},
"unique_email_address_for_account": "<string>",
"unique_email_address_for_contacts": "<string>"
}
},
"message": "<string>",
"object": "<string>",
"pagination": "<unknown>",
"url": "<string>"
}Send a list of fields under
field_settings.item.fields. Each entry names the field in name, its module such as item, and sets enabled and required as "true" or "false". The response lists field settings under data.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Body
application/json
Show child attributes
Show child attributes