CAcapacity
Custom Field Definitions

Create a custom field definition

Create a custom field definition.

post/v1/custom_field_definitions

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Request body

namestring
custom_field_type_idinteger
custom_field_definition_type_idinteger
is_enabledboolean
parent_idinteger nullable
json_schemaobject

Schema that allows default value to be overwritten, specifically ranges for numeric and decimal types

placeholderstring
future_onlyboolean

Used for datetime types to force future dates only

is_sensitiveboolean
is_value_dependency_enabledboolean

Denotes whether a child will have values dependent on the parent

Response

The created custom field definition

bodyobject

Json body data in the request

parametersobject

Query parameters in the request

Changes

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