Skip to main content

Customfieldlinkapiv1

customFieldEncodedKeystring

the key to the parent custom field definition

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472
isDefaultboolean

whether this field is displayed by default when creating a new record

isRequiredboolean

whether this field is required when creating a new record

linkTypestring

the type of entity this field represents a link to

Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

productKeystring

when the link type is product, this field should contain the encoded key of the linekd product

Customfieldlinkapiv1
{
"customFieldEncodedKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isDefault": true,
"isRequired": true,
"linkType": "CLIENT_ROLE",
"productKey": "string"
}