Create a Lookup Field

post

https://api.fireberry.com/api/v2/system-field/{objectType}/lookup

Path Params

objectType

int32

required

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

Body Params

fieldName

string

required

Defaults to pcf

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

label

string

required

Field name used for system displays.

relatedObjectType

int32

required

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

filterBy

string

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

defaultValue

string

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

boolean

Defaults to false

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

additionalProperty

string

enum

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

Allowed:

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200