v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Custom Field

Create a custom field definition

Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned.

post/customFieldDefinition

Request body

parentObjectType'ACCOUNT' | 'ORDER' | 'ORDER_ITEM' | 'PLAN' | 'CHARGE' | 'INVOICE' | 'SALES_ROOM' | 'SUBSCRIPTION' | 'SUBSCRIPTION_ITEM' | 'OPPORTUNITY' required
fieldType'STRING' | 'PICKLIST' | 'MULTISELECT_PICKLIST' required
fieldNamestring
fieldLabelstring
optionsstring[]
requiredboolean
source'USER' | 'SYSTEM'

Response

successful operation

string required