Skip to main content
POST
Create a new field for a specific model

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required
x-connector-id
string
header
required
x-owner-id
string
header
required
x-session-token
string
header
required

Path Parameters

modelId
enum<string>
required
Available options:
genericCompany,
genericContact,
genericUser,
genericWorkspace,
crmOpportunity,
crmStage,
crmPipeline,
crmEngagement,
telephonyCall,
telephonyCallTranscript,
schedulingEventType,
schedulingSlot,
schedulingEvent,
widgetCardView,
accountingInvoice,
accountingInvoiceLineItem,
accountingInvoiceItem

Body

key
string
required
name
string
required
type
enum<string>
required
Available options:
text,
number,
select,
boolean,
datetime,
list.text,
list.number,
list.select,
list.boolean,
list.datetime
description
string | null
format
string
unit
string
optionSource
string
options
object[]
remote
object

Response

Created

key
string
required
name
string
required
type
enum<string>
required
Available options:
text,
number,
select,
boolean,
datetime,
list.text,
list.number,
list.select,
list.boolean,
list.datetime
description
string | null
format
string
unit
string
optionSource
string
options
object[]
isRequired
boolean
isFieldReadOnly
boolean
isValueReadOnly
boolean
isCustom
boolean
remote
object