SMsmartsheet
custom_fields

Update custom field

Updates a custom field.

Editable properties:

  • name
  • description
  • options
  • default_value
  • is_visible_on_info_page
  • is_visible_as_filter
put/custom_fields/{custom_field_id}

Request

  • Base URL
    https://api.rm.smartsheet.com/api/v1
  • Auth
    API key in header auth

Request body

idinteger

The unique identifier of the custom field.

namestring

The name of the custom field.

descriptionstring

The description of the custom field.

namespace'assignables' | 'users'

The category for the custom field.

default_valuestring

The value to be applied if none is specified.

Important: If the custom field is a selection list (that is, it has drop-down field options), the default_value must be one of the options values or an empty string.

is_visible_on_info_pageboolean

If true, the custom field is visible on the info page.

is_visible_as_filterboolean

If true, the custom field is visible as a filter.

is_editable_only_by_adminsboolean

If true, only admins may edit this custom field.

Note: This property is only applicable to custom fields that have namespace set to users.

created_atstring date-time

Project creation date.

updated_atstring date-time

Date of the most recent modification.

data_type'string' | 'selection_list' | 'multiple_choice_selection_list'

The kind of data the custom field comprises.

optionsstring[]

An array of possible values for selection list custom fields.

This property only applies to custom fields of the following data types:

  • "selection_list"
  • "multiple_choice_selection_list"

Important: On creating a custom field with data type "selection_list" or "multiple_choice_selection_list", you must specify an options array.

Example request

{
  "name": "Skills",
  "created_at": "2025-01-22T06:00:30Z",
  "updated_at": "2025-01-22T06:13:40Z",
  "data_type": "multiple_choice_selection_list",
  "options": [
    "Audio/Video",
    "Graphic Design",
    "UX",
    "Analytics",
    "Python",
    "Ruby",
    "JavaScript"
  ]
}

Response

The updated custom field.

idinteger

The unique identifier of the custom field.

namestring

The name of the custom field.

descriptionstring

The description of the custom field.

namespace'assignables' | 'users'

The category for the custom field.

default_valuestring

The value to be applied if none is specified.

Important: If the custom field is a selection list (that is, it has drop-down field options), the default_value must be one of the options values or an empty string.

is_visible_on_info_pageboolean

If true, the custom field is visible on the info page.

is_visible_as_filterboolean

If true, the custom field is visible as a filter.

is_editable_only_by_adminsboolean

If true, only admins may edit this custom field.

Note: This property is only applicable to custom fields that have namespace set to users.

created_atstring date-time

Project creation date.

updated_atstring date-time

Date of the most recent modification.

data_type'string' | 'selection_list' | 'multiple_choice_selection_list'

The kind of data the custom field comprises.

optionsstring[]

An array of possible values for selection list custom fields.

This property only applies to custom fields of the following data types:

  • "selection_list"
  • "multiple_choice_selection_list"

Important: On creating a custom field with data type "selection_list" or "multiple_choice_selection_list", you must specify an options array.

Example response

{
  "name": "Skills",
  "created_at": "2025-01-22T06:00:30Z",
  "updated_at": "2025-01-22T06:13:40Z",
  "data_type": "multiple_choice_selection_list",
  "options": [
    "Audio/Video",
    "Graphic Design",
    "UX",
    "Analytics",
    "Python",
    "Ruby",
    "JavaScript"
  ]
}

Changes

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