> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.staging.frame.io/platform/v4/api-reference/metadata-fields/metadata-field-definitions-update/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server. # Update account level custom field definitions PATCH https://api.frame.io/v4/accounts/{account_id}/metadata/field_definitions/{field_definition_id} Content-Type: application/json Update account level custom field definitions. Rate Limits: 10 calls per 1.00 minute(s) per account\_user Reference: https://developer.staging.frame.io/platform/api-reference/metadata-fields/metadata-field-definitions-update ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `account_id` (string, required) - `field_definition_id` (string, required) ### Body (application/json) This endpoint expects an UpdateFieldDefinitionParams. - `data` (UpdateFieldDefinitionParamsData, optional) ## Response ### 200 OK - `data` (FieldDefinition, required) ## Errors ### 400 Bad Request Error Bad Request - `errors` (list of BadRequestErrorsItems, required) ### 401 Unauthorized Error Unauthorized - `errors` (list of UnauthorizedErrorsItems, required) ### 403 Forbidden Error Forbidden - `errors` (list of ForbiddenErrorsItems, required) ### 404 Not Found Error Not Found - `errors` (list of NotFoundErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable Entity - `errors` (list of UnprocessableEntityErrorsItems, required) ### 429 Too Many Requests Error Too Many Requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### UpdateFieldDefinitionParamsData ### FieldDefinition ### BadRequestErrorsItems - `detail` (string, required) - `source` (BadRequestErrorsItemsSource, optional) - `title` (string, optional) ### UnauthorizedErrorsItems - `detail` (string, required) - `source` (UnauthorizedErrorsItemsSource, optional) - `title` (string, optional) ### ForbiddenErrorsItems - `detail` (string, required) - `source` (ForbiddenErrorsItemsSource, optional) - `title` (string, optional) ### NotFoundErrorsItems - `detail` (string, required) - `source` (NotFoundErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableEntityErrorsItems - `detail` (string, required) - `source` (UnprocessableEntityErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### UpdateTextDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `name` (string, optional) — Field definition name ### UpdateLongTextDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `name` (string, optional) — Field definition name ### UpdateRatingDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateRatingDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateNumberDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateNumberDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateToggleDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateToggleDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateDateDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateDateDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateSelectDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateSelectDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateSelectMultiDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateSelectMultiDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateUserSingleDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateUserSingleDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### UpdateUserMultiDefinitionParams - `field_type` (enum, required) — Field type of the field definition to be updated - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single` - `field_configuration` (UpdateUserMultiDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### TextDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (TextDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### LongTextDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (LongTextDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### RatingDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (RatingDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### NumberDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (NumberDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### ToggleDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (ToggleDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### DateDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (DateDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### SelectDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (SelectDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### SelectMultiDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (SelectMultiDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### UserSingleDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (UserSingleDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### UserMultiDefinition - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (UserMultiDefinitionFieldConfiguration, required) - `field_type` (enum, required) — Field type - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `user_single`, `user_multi`, `date` - `id` (string, required) — Field definition ID - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated. - `name` (string, required) — FieldDefinition Name - `updated_at` (string, required) — Updated Timestamp ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### UnprocessableEntityErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ### UpdateRatingDefinitionParamsFieldConfiguration - `color` (string, optional) — Color value hex code for the `style` icon symbols. ex: #fbd400 - `max_value` (integer, optional) - `style` (enum, optional) — Field type - Allowed values: `star`, `heart`, `thumbs_up` ### UpdateNumberDefinitionParamsFieldConfiguration - `number_format` (enum, optional) — Number format - Allowed values: `bitrate`, `bits`, `duration`, `framerate`, `frequency`, `storage`, `timecode` - `scale` (integer, optional) — Number scale. Indicates the number of decimal places of precision for the number value ### UpdateToggleDefinitionParamsFieldConfiguration - `color` (string, optional) — Color value hex code. ex: #fbd400 ### UpdateDateDefinitionParamsFieldConfiguration - `display_format` (enum, optional, default: local) - Allowed values: `local`, `friendly`, `usa`, `euro`, `iso` - `display_timezone` (boolean, optional, default: false) - `include_time` (boolean, optional, default: false) - `time_format` (enum, optional, default: twelve_hour) - Allowed values: `twelve_hour`, `twenty_four_hour` ### UpdateSelectDefinitionParamsFieldConfiguration - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view - `options` (list of UpdateSelectDefinitionParamsFieldConfigurationOptionsItems, optional) ### UpdateSelectMultiDefinitionParamsFieldConfiguration - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view - `options` (list of UpdateSelectMultiDefinitionParamsFieldConfigurationOptionsItems, optional) ### UpdateUserSingleDefinitionParamsFieldConfiguration - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) - `custom_members` (list of UpdateUserSingleDefinitionParamsFieldConfigurationCustomMembersItems, optional) ### UpdateUserMultiDefinitionParamsFieldConfiguration - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) - `custom_members` (list of UpdateUserMultiDefinitionParamsFieldConfigurationCustomMembersItems, optional) ### TextDefinitionFieldConfiguration ### LongTextDefinitionFieldConfiguration ### RatingDefinitionFieldConfiguration - `max_value` (integer, required) - `color` (string, optional, nullable) — Color value hex code for the `style` icon symbols. ex: #fbd400 - `style` (enum, optional, nullable) — Field type - Allowed values: `star`, `heart`, `thumbs_up` ### NumberDefinitionFieldConfiguration - `scale` (integer, required) — Number scale. Indicates the number of decimal places of precision for the number value - `number_format` (enum, optional, nullable) — Number format - Allowed values: `bitrate`, `bits`, `duration`, `framerate`, `frequency`, `storage`, `timecode` ### ToggleDefinitionFieldConfiguration - `color` (string, required, nullable) — Color value hex code. ex: #fbd400 ### DateDefinitionFieldConfiguration - `display_format` (enum, required, default: local) - Allowed values: `local`, `friendly`, `usa`, `euro`, `iso` - `display_timezone` (boolean, optional, default: false) - `include_time` (boolean, optional, default: false) - `time_format` (enum, optional, default: twelve_hour) - Allowed values: `twelve_hour`, `twenty_four_hour` ### SelectDefinitionFieldConfiguration - `options` (list of SelectDefinitionFieldConfigurationOptionsItems, required) - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view ### SelectMultiDefinitionFieldConfiguration - `options` (list of SelectMultiDefinitionFieldConfigurationOptionsItems, required) - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view ### UserSingleDefinitionFieldConfiguration - `custom_members` (list of UserSingleDefinitionFieldConfigurationCustomMembersItems, required) - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) ### UserMultiDefinitionFieldConfiguration - `custom_members` (list of UserMultiDefinitionFieldConfigurationCustomMembersItems, required) - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) ### UpdateSelectDefinitionParamsFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400 ### UpdateSelectMultiDefinitionParamsFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400 ### UpdateUserSingleDefinitionParamsFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### UpdateUserMultiDefinitionParamsFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### SelectDefinitionFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400 - `id` (string, optional) ### SelectMultiDefinitionFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400 - `id` (string, optional) ### UserSingleDefinitionFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### UserMultiDefinitionFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ## Examples **Request** ```json { "data": { "field_type": "select", "name": "Updated-Field-Name" } } ``` **Response** ```json { "data": { "created_at": "2024-01-25T19:18:29.614189Z", "creator_id": "890ca621-d866-4b1b-b8c7-5a40c36ad72b", "field_configuration": {}, "field_type": "select", "id": "a10e2eaf-2032-4a58-863d-28b4102b1ddb", "mutable": true, "name": "Fields definition name", "updated_at": "2024-02-07T16:44:41.986478Z" } } ``` **SDK Code** ```python import requests url = "https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6" payload = { "data": { "field_type": "select", "name": "Updated-Field-Name" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"data":{"field_type":"select","name":"Updated-Field-Name"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6" payload := strings.NewReader("{\n \"data\": {\n \"field_type\": \"select\",\n \"name\": \"Updated-Field-Name\"\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"field_type\": \"select\",\n \"name\": \"Updated-Field-Name\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"field_type\": \"select\",\n \"name\": \"Updated-Field-Name\"\n }\n}") .asString(); ``` ```php request('PATCH', 'https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6', [ 'body' => '{ "data": { "field_type": "select", "name": "Updated-Field-Name" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"field_type\": \"select\",\n \"name\": \"Updated-Field-Name\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": [ "field_type": "select", "name": "Updated-Field-Name" ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/45cc53ac-fe63-4c7c-82ef-43bcaf701f37/metadata/field_definitions/dd2db9f7-3251-44b5-87e6-21caa9cc10c6")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```