{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Custom Field API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"custom-field-api-v3--developer-guide","__idx":0},"children":["Custom Field API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/custom-field"},"children":["Custom Field | Sprinklr Developer Portal"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Field"]}," is a fully customizable property or tag that can be created at several feature levels (for various assets) to organize and categorize content. Custom fields are managed in the Sprinklr UI under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings → Manage Workspace → Custom Fields"]},", and through this API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom Field V3 exposes create, read, and update on a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["single resource path"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/customField"]}," — differentiated by HTTP method:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create custom field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/customField"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch custom field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/customField?fieldName="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update custom field (v2-style merge)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/customField?id="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update custom field (partial / option edits)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/customField?id="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the central design change from V2, which spread the same capabilities across four separate kebab-case paths (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/custom-field"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/custom-field/{customFieldName}"]},", and the option-update endpoint). The V3 change set is:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Kebab-case paths converted to camelCase (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom-field"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customField"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Path-based parameters replaced by query parameters, per V3 convention."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No changes to request body fields"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," requests."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For endpoint-level reference documentation, see the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Custom Field V3"]}," tag in the V3 OpenAPI specification (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operationId"]}," values ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldApiV3_getCustomField"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldApiV3_createCustomField"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldApiV3_updateCustomField"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldApiV3_patchCustomFieldOptions"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-custom-field-data-model","__idx":2},"children":["1.1 The custom field data model"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Layer"},"children":["Layer"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Object"},"children":["Object"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it holds"},"children":["What it holds"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sprinklr ID, API name (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_…"]},"), and human-readable label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," is generated by Sprinklr on create"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Definition"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["What the field is and where it applies"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is the only ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," property in the schema"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Options"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Picklist options"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Applies only to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Governance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibility"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who sees and who can act on the field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Behavior"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldControllerById"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optionType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optionKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controlling-field (cascading picklist) configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["i18n"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Per-language translated labels/values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Epoch milliseconds"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read-only in practice"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-addressing-a-custom-field","__idx":3},"children":["1.2 Addressing a custom field"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A custom field is addressed in two ways, and the two are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["mutually exclusive"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["By field name"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},", the API name, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_62fc7b88b893784e3db68fa1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["By Sprinklr ID"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["69f021fb6357c2c9885e0eb5"]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", are ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"mutually exclusive with\""]}," the other. The acceptance criteria is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]},"; both parameters are accepted on all three methods per the specification."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To find ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," in the UI:"]}," hamburger menu → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Fields"]}," (under ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Manage Workspace"]},") → three dots next to the field → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy Field Name"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":4},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All API calls are sent to the production endpoint:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the custom field resource in production is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/customField\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", and so on — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the environment list)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":5},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Custom Field API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorize flow."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the application with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the request body media type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the acceptable response type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-write-operations","__idx":6},"children":["4. Write operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-create-a-custom-field","__idx":7},"children":["4.1 Create a custom field"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/customField"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new custom field. The request body is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]}," schema and is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unchanged from API v2"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":8},"children":["Request body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Data type of the field. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NUMBER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXT_MULTI"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXTAREA"]},". The only field marked ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," in the V3 schema."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required (v2 doc)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Label or tag for the custom field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the field. Should not exceed 500 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required (v2 doc)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset types the field applies to. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#8-supported-types-and-asset-types"},"children":["§8"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KeyLabelPair"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Picklist options as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"key\", \"label\" }"]}," pairs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Picklist options ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["with language-translation support"]},", as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"label\", \"value\", \"langVsTranslatedFieldValues\" }"]},". Preferred on V3."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category the field falls under."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the custom field is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibility"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visibility of the field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globallyVisible"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the field is visible across all users and workspaces."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibilityConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing configuration. If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibilityConfig"]}," is defined, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globallyVisible"]}," must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},". Each entry: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT_GROUP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER_GROUP"]},") and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Permission"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permission levels on the field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Space type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SPACE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Space in which the permissions are granted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionConfigs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permissions on the asset: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}," (List[String]; use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT_GROUP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER_GROUP"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optionType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Option type for the custom field, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GENERAL"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optionKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Option key for the custom field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldControllerById"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controlling-field (cascading) configuration, keyed by the controlling custom field's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enableReverseMapping"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables reverse mapping on the controller."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["controllingValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controlling values of the controller."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["controllingFieldConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, Array[String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maps each controlling value to the controlled values it exposes, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"option 1\": [\"test1\"]}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, Map[String, String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Translated fields, keyed by locale, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"es_ES\": {\"description\": \"…\"}}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String / Integer(int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Present in the schema; ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["server-generated"]},". Do not send on create."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dev note:"]}," when applying controlling custom field logic, the asset type for both the controlling and the controlled custom field must be the same."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":9},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/customField' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n  \"type\": \"PICKLIST\",\n  \"label\": \"Buy text books\",\n  \"description\": \"Text books\",\n  \"assetTypes\": [\n    \"UNIVERSAL_CASE\"\n  ],\n  \"valuesOptions\": [\n    { \"label\": \"Hindi Book\",   \"value\": \"Item3\" },\n    { \"label\": \"English Book\", \"value\": \"Item4\" },\n    { \"label\": \"Maths Book\",   \"value\": \"Item5\" }\n  ],\n  \"enabled\": true,\n  \"visibility\": {\n    \"globallyVisible\": true,\n    \"visibilityConfig\": []\n  },\n  \"permissions\": [],\n  \"optionType\": \"GENERAL\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response--200-ok","__idx":10},"children":["Response — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response remains wrapped in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"data\": { … }, \"errors\": [] }"]}," envelope, as in V2."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"id\": \"6a15774f00f392c2e656e68b\",\n    \"fieldName\": \"_c_6a15774e00f392c2e656e688\",\n    \"label\": \"Buy text books\",\n    \"description\": \"Text books\",\n    \"assetTypes\": [\n      \"CASE\"\n    ],\n    \"type\": \"PICKLIST\",\n    \"valuesOptions\": [\n      { \"label\": \"Hindi Book\",   \"value\": \"Item3\" },\n      { \"label\": \"English Book\", \"value\": \"Item4\" },\n      { \"label\": \"Maths Book\",   \"value\": \"Item5\" }\n    ],\n    \"enabled\": true,\n    \"visibility\": {\n      \"globallyVisible\": true,\n      \"visibilityConfig\": []\n    },\n    \"permissions\": [],\n    \"optionType\": \"GENERAL\",\n    \"createdTime\": 1779791695119,\n    \"modifiedTime\": 1779791695119\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"️-values-vs-valuesoptions--read-this-before-you-parse-the-response","__idx":11},"children":["⚠️ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," vs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," — read this before you parse the response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both keys represent picklist options, and they have ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different shapes"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key"},"children":["Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Item shape"},"children":["Item shape"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Translation support"},"children":["Translation support"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"key\": \"…\", \"label\": \"…\" }"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KeyLabelPair"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"label\": \"…\", \"value\": \"…\", \"langVsTranslatedFieldValues\": {…} }"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the inversion: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values[].key"]}," carries the stored value, while ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions[].value"]}," carries it. Do not map ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," positionally between the two."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-update-a-custom-field--full-merge-update","__idx":12},"children":["4.2 Update a custom field — full (merge) update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/customField?id={customFieldId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The fields present in the body are merged into the existing custom field. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["retains full update semantics"]}," and that the request body fields are unchanged from V2."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":13},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field ID. Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["69f021fb6357c2c9885e0eb5"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field API name. Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_62fc7b88b893784e3db68fa1"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supply exactly one of the two."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--customfieldv3updaterequest","__idx":14},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldV3UpdateRequest"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only these fields are merged into the existing field when present:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption_metadata"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replacement set of picklist options. Item fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," (Map[String,String]), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merged into the existing field when present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merged into the existing field when present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merged into the existing field when present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merged into the existing field when present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, Map[String, String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merged into the existing field when present."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," are not in the update schema."]}," See the type-change caveat below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":15},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/customField?id=69f021fb6357c2c9885e0eb5' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n  \"description\": \"Updated description\",\n  \"category\": \"Support\",\n  \"enabled\": true,\n  \"assetTypes\": [\n    \"UNIVERSAL_CASE\"\n  ],\n  \"valuesOptions\": [\n    { \"label\": \"Yes\",   \"value\": \"Yes\" },\n    { \"label\": \"No\",    \"value\": \"No\" },\n    { \"label\": \"Maybe\", \"value\": \"Maybe\" }\n  ],\n  \"langVsTranslatedFieldValues\": {\n    \"es_ES\": { \"description\": \"Descripción actualizada\" }\n  }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response","__idx":16},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," responds ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," with no response body"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"️-changing-type-is-not-supported","__idx":17},"children":["⚠️ Changing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is not supported"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updating the field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["is not supported"]},". ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"the v2 api did not have support for updating the type. The same behaviour exists here as well.\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What this means for you:"]}," do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," in an update payload and do not rely on the response status to tell you a type change was rejected. If you need a different type, create a new custom field."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-update-a-custom-field--partial-update-and-option-edits","__idx":18},"children":["4.3 Update a custom field — partial update and option edits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/customField?id={customFieldId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adds new picklist options and deletes existing ones without resending the full option set, and optionally applies the same merge fields as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},". The OpenAPI summary is ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Partial update (picklist options and/or PUT-merge fields)\""]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-1","__idx":19},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identical to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},", mutually exclusive."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--customfieldv3patchrequest","__idx":20},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldV3PatchRequest"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addedValuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption_metadata"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Adds"]}," new options to the existing option set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removedValuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set[String] (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LinkedHashSet<String>"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Removes"]}," existing options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption_metadata"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full option set, as on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT-merge field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT-merge field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT-merge field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT-merge field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, Map[String, String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT-merge field."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldOption_metadata"]}," item fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," (Map[String,String]), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-2","__idx":21},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/customField?id=69f179317de8c9de2ad70475' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n  \"addedValuesOptions\": [\n    { \"label\": \"Optical1\", \"value\": \"test1\" },\n    { \"label\": \"Optical2\", \"value\": \"test2\" }\n  ],\n  \"removedValuesOptions\": [\n    \"Item5\"\n  ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-1","__idx":22},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," responds ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," with no response body"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"️-only-picklist-and-picklist_multiselect-support-option-updates","__idx":23},"children":["⚠️ Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}," support option updates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}," field types support option updates via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-method-comparison--when-to-use-which","__idx":24},"children":["4.4 Method comparison — when to use which"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POST"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PUT"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PATCH"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new custom field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merge-update the definition"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add/remove options, plus merge fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Addressing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — identity is generated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldV3UpdateRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldV3PatchRequest"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Option semantics"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set at creation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," — whole set"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addedValuesOptions"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removedValuesOptions"]}," — incremental"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Can change ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes (set at creation)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{data, errors}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]},", no body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]},", no body"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," take ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different body schemas"]},". You cannot reuse one payload for both methods."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Choosing the right option operation:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Intent"},"children":["Intent"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Append one option to a large picklist"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addedValuesOptions"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retire a single option"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removedValuesOptions"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replace the entire option set with an authoritative list"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},") with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," where you meant ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addedValuesOptions"]}," replaces the whole option set and drops every option you did not resend."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-read-operations","__idx":25},"children":["5. Read operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-get-apiv3customfield--fetch-a-custom-field","__idx":26},"children":["5.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/customField"]}," — Fetch a custom field"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetches custom field details by field name or by ID. Replaces the V2 path-parameter endpoint."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field API name (for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_field"]},"). Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_62fc7b88b893784e3db68fa1"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field ID. Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a15774f00f392c2e656e68b"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# By field name — the primary lookup per IN-12885\ncurl --location 'https://api3.sprinklr.com/{env}/api/v3/customField?fieldName=_c_62fc7b88b893784e3db68fa1' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# By ID\ncurl --location 'https://api3.sprinklr.com/{env}/api/v3/customField?id=6a15774f00f392c2e656e68b' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response--200-ok-1","__idx":27},"children":["Response — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI document types the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response as an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]}]},", whereas ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," returns a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]},". Handle the read response as a collection even when you addressed a single field."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"62fc7b88b893784e3db68fa6\",\n      \"fieldName\": \"_c_62fc7b88b893784e3db68fa1\",\n      \"label\": \"profile check\",\n      \"assetTypes\": [\n        \"PROFILE\"\n      ],\n      \"type\": \"PICKLIST_MULTISELECT\",\n      \"values\": [\n        { \"key\": \"Tag\",  \"label\": \"Tag\" },\n        { \"key\": \"Tag1\", \"label\": \"Tag1\" }\n      ],\n      \"category\": \"\",\n      \"enabled\": true,\n      \"visibility\": {\n        \"globallyVisible\": true,\n        \"visibilityConfig\": []\n      },\n      \"permissions\": []\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format-and-status-codes","__idx":28},"children":["6. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-the-v3-envelope","__idx":29},"children":["6.1 The V3 envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," responses use the two-part envelope:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": { },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (or Array on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The custom field object(s)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Error]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of error objects; empty when there are no errors"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no body"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":30},"children":["6.2 Response codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP code"},"children":["HTTP code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success. Body contains the custom field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success. No response body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid parameters, invalid body, or an unsupported operation such as an option edit on a non-picklist type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions on the custom field or workspace."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No custom field matches the supplied ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-v2--v3-migration","__idx":31},"children":["7. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-endpoint-mapping","__idx":32},"children":["7.1 Endpoint mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-custom-field"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/custom-field"]}]}," (create)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/customField"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/fetch-custom-field-using-field-name"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/custom-field/{customFieldName}"]}]}," (fetch)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/customField?fieldName="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Custom Field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/customField?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/update-options-with-label"},"children":["Update Options with Label"]}," (assign a new value or delete an existing value for a given custom field name)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/customField?id="]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addedValuesOptions"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removedValuesOptions"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The single biggest structural change: V2 used ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["path"]}," parameters on kebab-case paths (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/custom-field/{customFieldName}"]},"); V3 uses ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["query"]}," parameters on one camelCase path (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/customField?fieldName="]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-what-changed-and-what-did-not","__idx":33},"children":["7.2 What changed and what did not"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V2"},"children":["API V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V3"},"children":["API V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Impact"},"children":["Impact"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path casing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom-field"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customField"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update every URL"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field addressing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{customFieldName}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?fieldName="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update URL construction; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," lookup is new"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create request body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomField"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unchanged"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No payload migration needed for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update request body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v2 merge fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFieldV3UpdateRequest"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["same fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No payload migration needed for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]},", no body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stop parsing the update response; treat 2xx as success"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Option edits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Separate \"Update Options with Label\" endpoint"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," on the same resource"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consolidate to one path and one method"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Option representation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["and"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," + translations)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prefer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," for i18n"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create response option key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoes the key you sent (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," in, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," out) — fixed under IN-13195"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parse defensively"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{data, errors}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{data, errors}"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unchanged"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No change"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-supported-types-and-asset-types","__idx":34},"children":["8. Supported types and asset types"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-custom-field-types","__idx":35},"children":["8.1 Custom field types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Select only one value from the available options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Select more than one value from the available options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NUMBER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value in numerical form — phone number, employee ID, and similar."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DATE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A calendar picker; for example purchase date, complaint date, completion date."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text details — name, customer ID, description."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXTAREA"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same as text but holds greater length."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEXT_MULTI"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Like a multi-picklist, but no values are defined at creation; options are created on the go."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}," accept option definitions and option updates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-supported-asset-types","__idx":36},"children":["8.2 Supported asset types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUTBOUND_MESSAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIA_ASSET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CAMPAIGN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUB_CAMPAIGN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMMUNITY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRODUCT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIVERSAL_CASE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SURVEY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TASK"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-use-cases","__idx":37},"children":["9. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-provision-a-case-tagging-picklist-from-your-deployment-pipeline","__idx":38},"children":["9.1 Provision a case-tagging picklist from your deployment pipeline"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Issue a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/customField"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"PICKLIST\""]},", the target ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]},", and the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," set. Capture ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.fieldName"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_…"]},") from the response and store it — it is the addressing key for every later read and update, and it is also the key you use when writing values onto a profile or case."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-add-one-option-to-a-live-picklist-without-disturbing-the-rest","__idx":39},"children":["9.2 Add one option to a live picklist without disturbing the rest"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", mutate, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," the whole option list — a concurrent editor's option would be lost. Use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"addedValuesOptions\": [ { \"label\": \"Priority Support\", \"value\": \"priority_support\" } ] }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," takes a distributed lock on the field (added under IN-13211), so concurrent adds do not clobber each other."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-retire-an-option-that-is-no-longer-offered","__idx":40},"children":["9.3 Retire an option that is no longer offered"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"removedValuesOptions\": [\"legacy_plan\"] }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Removing an option does not delete the field. If you need the whole field out of circulation, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"enabled\": false}"]}," instead — there is no delete endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-localize-a-picklist-for-a-new-market","__idx":41},"children":["9.4 Localize a picklist for a new market"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Translations live in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["langVsTranslatedFieldValues"]},", at both field level and option level:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"valuesOptions\": [\n    {\n      \"label\": \"Hindi Book\",\n      \"value\": \"Item3\",\n      \"langVsTranslatedFieldValues\": {\n        \"es_ES\": { \"label\": \"Libro de hindi\" }\n      }\n    }\n  ],\n  \"langVsTranslatedFieldValues\": {\n    \"es_ES\": { \"description\": \"Descripción actualizada\" }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is exactly why ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," exists alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KeyLabelPair"]}," has no translation slot."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"95-build-a-cascading-controlling-picklist","__idx":42},"children":["9.5 Build a cascading (controlling) picklist"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldControllerById"]},", keyed by the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["controlling"]}," field's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["controlled"]}," field:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"customFieldControllerById\": {\n    \"66b0b924b8f96b59e3003ce3\": {\n      \"controllingFieldConfig\": {\n        \"option 1\": [\"test1\"],\n        \"option 2\": [\"test2\"]\n      }\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["option 1"]}," is selected on the controlling field, only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test1"]}," is offered on this field. Both fields must share the same asset type."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"96-resolve-a-fieldname-you-copied-from-the-ui","__idx":43},"children":["9.6 Resolve a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," you copied from the UI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/customField?fieldName=_c_62fc7b88b893784e3db68fa1"]}," returns the definition, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," — check it before sending option edits, since only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]}," accept them."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"97-reconcile-a-picklist-against-an-authoritative-external-list","__idx":44},"children":["9.7 Reconcile a picklist against an authoritative external list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When your system owns the complete option set (for example, a product catalog), compute the delta and send one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"addedValuesOptions\": [\n    { \"label\": \"Model X2\", \"value\": \"model_x2\" }\n  ],\n  \"removedValuesOptions\": [\"model_w1\"]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A delta ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," is safer than a wholesale ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," replacement because it leaves options added by other systems intact."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-caveats-and-best-practices","__idx":45},"children":["10. Caveats and best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method selection"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," take different body schemas. Payloads are not interchangeable."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," for incremental option work; reserve full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," replacement for when you own the entire list."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["There is no delete. Plan for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled: false"]}," as the retirement mechanism."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identifiers"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," are mutually exclusive on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},". Send exactly one."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," values are prefixed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_"]},". Copy them from the create response or from the UI (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy Field Name"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send option ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," as strings, not numbers (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://sprinklr.atlassian.net/browse/IN-13205"},"children":["IN-13205"]},")."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Types"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," cannot be changed after creation. Create a new field instead."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Option fields are meaningful only for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PICKLIST_MULTISELECT"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response handling"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," (read/create) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," (update) both as success; do not assert on a single status code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not attempt to parse an update response body — there is none."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Accept both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valuesOptions"]}," when reading options, and mind the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," ↔ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," inversion."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not assume ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetTypes"]}," round-trips exactly as sent."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Governance"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibilityConfig"]}," is populated, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globallyVisible"]}," must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions[].spaceType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions[].spaceId"]}," are both required whenever a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Permission"]}," entry is supplied."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Constraints carried from V2"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," should not exceed 500 characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A controlling field and its controlled field must share the same asset type."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["All JSON payloads in this guide are illustrative examples. They are not real customer data and are not guaranteed production responses. All credentials are placeholders (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{accessToken}}"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]},") and must never be committed or logged."]}]}]},"headings":[{"value":"Custom Field API V3 — Developer Guide","id":"custom-field-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The custom field data model","id":"11-the-custom-field-data-model","depth":3},{"value":"1.2 Addressing a custom field","id":"12-addressing-a-custom-field","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Write operations","id":"4-write-operations","depth":2},{"value":"4.1 Create a custom field","id":"41-create-a-custom-field","depth":3},{"value":"Request body","id":"request-body","depth":4},{"value":"Request","id":"request","depth":4},{"value":"Response — 200 OK","id":"response--200-ok","depth":4},{"value":"⚠️ values vs valuesOptions — read this before you parse the response","id":"️-values-vs-valuesoptions--read-this-before-you-parse-the-response","depth":4},{"value":"4.2 Update a custom field — full (merge) update","id":"42-update-a-custom-field--full-merge-update","depth":3},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Request body — CustomFieldV3UpdateRequest","id":"request-body--customfieldv3updaterequest","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"Response","id":"response","depth":4},{"value":"⚠️ Changing type is not supported","id":"️-changing-type-is-not-supported","depth":4},{"value":"4.3 Update a custom field — partial update and option edits","id":"43-update-a-custom-field--partial-update-and-option-edits","depth":3},{"value":"Query parameters","id":"query-parameters-1","depth":4},{"value":"Request body — CustomFieldV3PatchRequest","id":"request-body--customfieldv3patchrequest","depth":4},{"value":"Request","id":"request-2","depth":4},{"value":"Response","id":"response-1","depth":4},{"value":"⚠️ Only PICKLIST and PICKLIST_MULTISELECT support option updates","id":"️-only-picklist-and-picklist_multiselect-support-option-updates","depth":4},{"value":"4.4 Method comparison — when to use which","id":"44-method-comparison--when-to-use-which","depth":3},{"value":"5. Read operations","id":"5-read-operations","depth":2},{"value":"5.1 GET /api/v3/customField — Fetch a custom field","id":"51-get-apiv3customfield--fetch-a-custom-field","depth":3},{"value":"Response — 200 OK","id":"response--200-ok-1","depth":4},{"value":"6. Response format and status codes","id":"6-response-format-and-status-codes","depth":2},{"value":"6.1 The V3 envelope","id":"61-the-v3-envelope","depth":3},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"7. V2 → V3 migration","id":"7-v2--v3-migration","depth":2},{"value":"7.1 Endpoint mapping","id":"71-endpoint-mapping","depth":3},{"value":"7.2 What changed and what did not","id":"72-what-changed-and-what-did-not","depth":3},{"value":"8. Supported types and asset types","id":"8-supported-types-and-asset-types","depth":2},{"value":"8.1 Custom field types","id":"81-custom-field-types","depth":3},{"value":"8.2 Supported asset types","id":"82-supported-asset-types","depth":3},{"value":"9. Use cases","id":"9-use-cases","depth":2},{"value":"9.1 Provision a case-tagging picklist from your deployment pipeline","id":"91-provision-a-case-tagging-picklist-from-your-deployment-pipeline","depth":3},{"value":"9.2 Add one option to a live picklist without disturbing the rest","id":"92-add-one-option-to-a-live-picklist-without-disturbing-the-rest","depth":3},{"value":"9.3 Retire an option that is no longer offered","id":"93-retire-an-option-that-is-no-longer-offered","depth":3},{"value":"9.4 Localize a picklist for a new market","id":"94-localize-a-picklist-for-a-new-market","depth":3},{"value":"9.5 Build a cascading (controlling) picklist","id":"95-build-a-cascading-controlling-picklist","depth":3},{"value":"9.6 Resolve a fieldName you copied from the UI","id":"96-resolve-a-fieldname-you-copied-from-the-ui","depth":3},{"value":"9.7 Reconcile a picklist against an authoritative external list","id":"97-reconcile-a-picklist-against-an-authoritative-external-list","depth":3},{"value":"10. Caveats and best practices","id":"10-caveats-and-best-practices","depth":2}],"frontmatter":{"seo":{"title":"Custom Field API V3 — Developer Guide"}},"lastModified":"2026-10-12T04:13:20.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/custom-field-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}