v1

latestOpenAPI 3.1.02026-07-242442479.7 KB

Create a Lookup Field

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

objectTypeinteger required

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

fieldNamestring required

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

labelstring required

Field name used for system displays.

relatedObjectTypeinteger required

The number of the object type this field will relate records from.

filterBystring

Set a system field name to filter the results provided by the chosen field.

defaultValuestring

Value used by default for this field. Must match field requirements, in this case a record's ID from the correct object type.

followboolean

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

additionalProperty'required' | 'readonly'

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

200

object required