Directory Design

Updates a directory field.

Each field definition includes: Name (the identifier used in all queries), Type (data type), Label (optional friendly display name), Unique, and Description (optional, customer-defined).

Data types: TEXT255 (max 255 chars), TEXT64K (max 64K chars), NUMBER (decimal), INTEGER, CURRENCY, DATE/TIME, YES/NO (boolean), FILE (legacy), ATTACHMENT (file upload with constraints), PASSWORD, LIST-STRING, LIST-NUMBER, LIST-DATE/TIME (multi-select with predefined options), TIMESTAMP, RANDOM ID, AUTONUMBER, PREFIXED AUTONUMBER, GUID.

Note: PK_ID is system-managed and cannot be modified. Formula fields cannot be modified via the REST API.

Always use field Name (never Label) in SELECT, WHERE, ORDER BY, and GROUP BY clauses.

patch/v4/directories/{directoryId}/fields/{fieldName}

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/directories/{directoryId}/fields/{fieldName}
  • Auth: API key in header Authorization

Path parameters

directoryIdstring required

The directory identifier (6-character alphanumeric code).

fieldNamestring required

The field name.

Query parameters

echoboolean

When true, returns the updated field in the response. Default: false.

Request body

displayOrderinteger nullable
namestring nullable
labelstring nullable
descriptionstring nullable
dataTypestring nullable
uniqueboolean nullable
uniqueAllowNullsboolean nullable
stampOnInsertboolean nullable
stampOnUpdateboolean nullable
stampTimeZonestring nullable
formatstring nullable
prefixstring nullable
lengthinteger nullable
listFieldstring[] nullable
attachmentPermittedFileTypesstring[] nullable
attachmentMinFileSizeinteger nullable
attachmentMaxFileSizeinteger nullable
attachmentSmartResizerboolean nullable
attachmentSmartResizerForRetinaboolean nullable
attachmentAltTextstring nullable
attachmentTitlestring nullable

Response

OK

Changes

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