DEdealhub
Custom Field

Update an existing custom field definition

Updates an existing custom field definition for your tenant. On success the update custom field definition is returned.

put/customFieldDefinition/{id}

Request

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

Path parameters

idstring required

Request body

fieldNamestring
fieldLabelstring
fieldType'STRING' | 'PICKLIST' | 'MULTISELECT_PICKLIST'
optionsstring[]

Response

successful operation

idstring
parentObjectType'ACCOUNT' | 'ORDER' | 'ORDER_ITEM' | 'PLAN' | 'CHARGE' | 'INVOICE' | 'SALES_ROOM' | 'SUBSCRIPTION' | 'SUBSCRIPTION_ITEM' | 'OPPORTUNITY'
fieldType'STRING' | 'PICKLIST' | 'MULTISELECT_PICKLIST'
fieldNamestring
fieldLabelstring
optionsstring[]
requiredboolean
createdOninteger
updatedOninteger

Changes

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