Field Updated

Developing

Develop Env

https://api-develop.enspace.io

PUT

/ws/types/{slug}/fields/{fieldId}

Maintainer:Julio Cordeiro

Update Field

Updates the settings of an existing field.

Parameters

slug (path) - Unique slug of the Type

fieldId (path) - ID of the Field

Request Body

Only the fields sent will be updated. It is not necessary to send all fields.

Important Notes

⚠️ Be careful when updating fields in use:

Changing a field type may cause data loss

Making a field required may invalidate existing items

Deactivating a field does not delete data, it only hides the field

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

en-workspace

Example:

en-workspace: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Field updated.

Body

🟠400Invalid request

🟠401Unauthorized

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api-develop.enspace.io/ws/types//fields/' \
--header 'x-api-key: <api-key>' \
--header 'en-workspace: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "slug": "string",
    "type": "text",
    "required": false,
    "config": {
        "property1": "string",
        "property2": "string"
    },
    "order": 0
}'

Response Example

200 - Example 1

Get Field

Delete Field

Field Updated

Update Field#

Parameters#