DEdealhub
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

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/customFieldDefinition
  • Auth
    API key in header X-API-Key

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

Changes

No recorded changes to this operation across all 1 revision of this API.