v1

latestOpenAPI 3.1.02026-07-242442479.7 KB

Create a Text Field

post/api/v2/system-field/{objectType}/text

Path parameters

objectTypeinteger required

Use an object's number here to assign this field to an object.

Request body

fieldNamestring required

System field name. Must start with 'pcf' or the field will not be created.

labelstring required

Field name used for system displays.

autoCompleteboolean

To autocomplete values for this field, enter ׳true׳.

defaultValuestring

Value used by default for this field. Must match field requirements.

followboolean

To track all changes made to this field, enter ׳true׳.

maxLengthinteger

Number between 1-200 to limit length of text.

additionalProperty'required' | 'readonly'

Select required or read only to set these properties, or leave blank.

Response

200

object required