v1

latestOpenAPI 3.1.02026-07-242442479.7 KB

Update a Lookup Field

put/api/v2/system-field/{objectType}/lookup/{fieldName}

Path parameters

objectTypeinteger required

The number of the object the field being updated can be found in.

fieldNamestring required

The system name of the field being updated.

Request body

labelstring

Field name used for system displays.

filterBystring

The system name of the lookup field which will filter the results.

defaultValuestring

Value used by default for this field. Must match field requirements, in this case a record's GUID.

followboolean

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

additionalProperty'none' | 'required' | 'readonly'

Set any additional properties by selecting them, or select none.

Response

200

object required