Bulk full-replace and/or soft-delete of compliance custom field definitions in a single transaction.

curl --request PUT \
  --url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 123,
    "name": "<string>",
    "userDefinedId": "<string>",
    "position": 123,
    "internalOnly": true,
    "isMandatory": true,
    "isMultiLine": true,
    "isSortByAllowedValueId": true,
    "maxChar": 123,
    "allowedDecimals": 123,
    "parentCustomFieldId": 123,
    "allowedValues": [
      {
        "id": 123,
        "value": "<string>",
        "userDefinedId": "<string>",
        "isDefaultValue": true
      }
    ]
  }
]
'

import requests

url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"

payload = [
    {
        "id": 123,
        "name": "<string>",
        "userDefinedId": "<string>",
        "position": 123,
        "internalOnly": True,
        "isMandatory": True,
        "isMultiLine": True,
        "isSortByAllowedValueId": True,
        "maxChar": 123,
        "allowedDecimals": 123,
        "parentCustomFieldId": 123,
        "allowedValues": [
            {
                "id": 123,
                "value": "<string>",
                "userDefinedId": "<string>",
                "isDefaultValue": True
            }
        ]
    }
]
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      id: 123,
      name: '<string>',
      userDefinedId: '<string>',
      position: 123,
      internalOnly: true,
      isMandatory: true,
      isMultiLine: true,
      isSortByAllowedValueId: true,
      maxChar: 123,
      allowedDecimals: 123,
      parentCustomFieldId: 123,
      allowedValues: [{id: 123, value: '<string>', userDefinedId: '<string>', isDefaultValue: true}]
    }
  ])
};

fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields",
  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([
    [
        'id' => 123,
        'name' => '<string>',
        'userDefinedId' => '<string>',
        'position' => 123,
        'internalOnly' => true,
        'isMandatory' => true,
        'isMultiLine' => true,
        'isSortByAllowedValueId' => true,
        'maxChar' => 123,
        'allowedDecimals' => 123,
        'parentCustomFieldId' => 123,
        'allowedValues' => [
                [
                                'id' => 123,
                                'value' => '<string>',
                                'userDefinedId' => '<string>',
                                'isDefaultValue' => true
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"

	payload := strings.NewReader("[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]")

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

	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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]"

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

{
  "status": "success",
  "code": "<string>",
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "userDefinedId": "<string>",
      "type": "allowedValue",
      "state": "active",
      "position": 123,
      "maxChar": 123,
      "allowedDecimals": 123,
      "parentCustomFieldId": 123,
      "parentCustomFieldName": "<string>",
      "allowedValues": [
        {
          "id": 123,
          "value": "<string>",
          "userDefinedId": "<string>",
          "properties": [
            "<string>"
          ]
        }
      ],
      "properties": [
        "<string>"
      ]
    }
  ]
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

ComplianceCustomFields

Bulk full-replace and/or soft-delete of compliance custom field definitions in a single transaction.

Bulk PUT with all-or-nothing semantics. Each item must include id and is a full replace: every field is written verbatim (name + state required, omitted booleans reset to false, omitted nullable scalars clear, allowedValues full-replacement). state=“deleted” routes that item through the soft-delete code path so delete-time rules fire; mixed update + delete batches commit together. Capped at 200 items per request.

PUT

api

compliance-custom-fields

curl --request PUT \
  --url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 123,
    "name": "<string>",
    "userDefinedId": "<string>",
    "position": 123,
    "internalOnly": true,
    "isMandatory": true,
    "isMultiLine": true,
    "isSortByAllowedValueId": true,
    "maxChar": 123,
    "allowedDecimals": 123,
    "parentCustomFieldId": 123,
    "allowedValues": [
      {
        "id": 123,
        "value": "<string>",
        "userDefinedId": "<string>",
        "isDefaultValue": true
      }
    ]
  }
]
'

import requests

url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"

payload = [
    {
        "id": 123,
        "name": "<string>",
        "userDefinedId": "<string>",
        "position": 123,
        "internalOnly": True,
        "isMandatory": True,
        "isMultiLine": True,
        "isSortByAllowedValueId": True,
        "maxChar": 123,
        "allowedDecimals": 123,
        "parentCustomFieldId": 123,
        "allowedValues": [
            {
                "id": 123,
                "value": "<string>",
                "userDefinedId": "<string>",
                "isDefaultValue": True
            }
        ]
    }
]
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      id: 123,
      name: '<string>',
      userDefinedId: '<string>',
      position: 123,
      internalOnly: true,
      isMandatory: true,
      isMultiLine: true,
      isSortByAllowedValueId: true,
      maxChar: 123,
      allowedDecimals: 123,
      parentCustomFieldId: 123,
      allowedValues: [{id: 123, value: '<string>', userDefinedId: '<string>', isDefaultValue: true}]
    }
  ])
};

fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields",
  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([
    [
        'id' => 123,
        'name' => '<string>',
        'userDefinedId' => '<string>',
        'position' => 123,
        'internalOnly' => true,
        'isMandatory' => true,
        'isMultiLine' => true,
        'isSortByAllowedValueId' => true,
        'maxChar' => 123,
        'allowedDecimals' => 123,
        'parentCustomFieldId' => 123,
        'allowedValues' => [
                [
                                'id' => 123,
                                'value' => '<string>',
                                'userDefinedId' => '<string>',
                                'isDefaultValue' => true
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"

	payload := strings.NewReader("[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]")

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

	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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": 123,\n    \"name\": \"<string>\",\n    \"userDefinedId\": \"<string>\",\n    \"position\": 123,\n    \"internalOnly\": true,\n    \"isMandatory\": true,\n    \"isMultiLine\": true,\n    \"isSortByAllowedValueId\": true,\n    \"maxChar\": 123,\n    \"allowedDecimals\": 123,\n    \"parentCustomFieldId\": 123,\n    \"allowedValues\": [\n      {\n        \"id\": 123,\n        \"value\": \"<string>\",\n        \"userDefinedId\": \"<string>\",\n        \"isDefaultValue\": true\n      }\n    ]\n  }\n]"

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

{
  "status": "success",
  "code": "<string>",
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "userDefinedId": "<string>",
      "type": "allowedValue",
      "state": "active",
      "position": 123,
      "maxChar": 123,
      "allowedDecimals": 123,
      "parentCustomFieldId": 123,
      "parentCustomFieldName": "<string>",
      "allowedValues": [
        {
          "id": 123,
          "value": "<string>",
          "userDefinedId": "<string>",
          "properties": [
            "<string>"
          ]
        }
      ],
      "properties": [
        "<string>"
      ]
    }
  ]
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Headers

X-Delogue-Api

string

Body

integer<int64>

required

Unique identifier of the compliance custom field to update. Required on every bulk item.

name

null | string

Display name of the field. Required on a full replace; on PATCH it is preserved when the patch does not touch it.

userDefinedId

null | string

Customer-defined identifier for the field. Null clears the stored value; on PATCH omit it to preserve the current value.

state

null | enum<string>

Target lifecycle state of the field. Required on a full replace and, on PATCH, preserved when the patch does not touch it.

Available options:

active,

inactive,

deleted

position

Read-only. Sending a non-null value is rejected with a 400 validation error; omit it or send null.

internalOnly

boolean

When true, the field is visible to brand users only. On a full replace, an omitted value resets it to false.

isMandatory

boolean

When true, the field must be filled in before submission. On a full replace, an omitted value resets it to false.

isMultiLine

boolean

When true, a text-type field renders as a multi-line text area. On a full replace, an omitted value resets it to false.

isSortByAllowedValueId

boolean

When true, allowed values sort by insertion order rather than alphabetically. On a full replace, an omitted value resets it to false.

maxChar

Maximum character length allowed for a text-type field. Null clears the limit.

allowedDecimals

Number of decimal places allowed for a numeric-type field. Null clears the setting.

parentCustomFieldId

null | integer<int64>

Identifier of the parent field for a nestedAllowedValue child. Null clears the parent link.

allowedValues

null | object[]

Full replacement list of selectable options for allowedValue and nestedAllowedValue fields. Omit or send null to clear all existing options.

Show child attributes

Response

status

enum<string>

required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:

success,

error

code

string

required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data

null | object[]

required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.

Show child attributes

Barcodes

Brands

CareInstructionIcons

CareInstructionLayers

CareInstructionMaterials

CareInstructions

Color Groups

Colors

ComplianceCategories

ComplianceCustomFields

Facilities

Groups

ItemCategories

Items

MeasurementCharts

MigrationVerification

Organizations

SampleRequests

SampleTypes

Seasons

SizeRanges

Style Prices

StyleCareInstructions

StyleCategories

StyleColors

StyleContacts

StyleCustomFields

StyleFiles

StyleItems

StyleRelations

Styles

StyleSkus

StyleSupplierFacilities

SubSuppliers

Suppliers

Bulk full-replace and/or soft-delete of compliance custom field definitions in a single transaction.

Headers

Body

Response