Step 3: Create a New Custom Field

Creating a new Custom Field via the Custom Fields: Create endpoint is now performed via Resource Configuration: Create.

Notable Callouts

In addition to the base endpoint changing, some notable differences between the API calls are:

Custom Fields API requires the name and type be specified. Configuration API requires the $id, $schema, displayName, typeId, localization, group be specified
- type is also required if you are creating a booleanType, dateType, decimalType, imageType, listType, optionType, richTextType, stringType, structType, or videoType.
The response is now a JSON object, not an array.
localization is now required to be specified explicitly. In the Custom FIelds API, it defaults to “PRIMARY_ONLY”.
group is now required to specified explicitly - in the Custom FIelds API, it defaults to “NONE”.

Custom Fields API

Custom Fields: Create


POST	https://api.yextapis.com/v2/accounts/{accountId}/customfields

[
    {
    "name":{
        "value":"My New Boolean Field",
        "translations":[]
    },
    "group":"NONE",
    "type":"BOOLEAN"
}
]

Resource Configuration API

Resource Configuration: Create


POST	https://api.yextapis.com/v2/accounts/{accountId}/config/resources/km/field

{
    "$id":"c_myNewBooleanField",
    "$schema":"https://schema.yext.com/config/km/field/v1",
    "displayName":"My New Boolean Field",
    "group":"NONE",
    "localization":"PRIMARY_ONLY",
    "type":{
        "booleanType":{}
    },
    "typeId":"boolean"
}

Feedback

<% elem.innerText %>