Update Field

PUT

https://app.smartsuite.com/api/v1/applications/[tableId]/change_field/

Updates a field in the specified Table (App).

Example Request

curl -X PUT https://app.smartsuite.com/api/v1/applications/646536cac79b49252b0f94f5/change_field/ \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{
    "slug": "[Existing Field Slug]",
    "label": "[Field Name]",
    "field_type": "[Field Type]",
    "params": {
      [Field-Specific Parameters]
    }
  }'

field object See Definition

Path Parameters

Param	Type	Description
tableId	string	The Id of the Table (App) in which to update the field.

Query Parameters

Param	Type	Optional	Description
set_is_migrating	number	Yes	Set to 1 when the change affects how existing values are stored, such as changing the field type.

caution

Without set_is_migrating=1, a change of field type returns 200 OK but is not applied. Check the result with Get Table.

Request Body

Param	Type	Optional	Description
slug	string	No	The slug of the existing field to update.
label	string	No	The field name.
field_type	string	No	The field type (see Field Types).
params	object	No	field-specific parameters.

Note

The request body is the bare field object. Add Field is different: it wraps the definition in a field key.

Send the complete field definition, including all params.

Response

Returns 200 OK with an empty body. Use Get Table to read the stored field definition.