> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://next.developer.frame.io/platform/v4-experimental/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://next.developer.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. This endpoint has been added to `Current Version` of the API. Please see [https://developer.adobe.com/frameio/api/current/#tag/Files/operation/metadata.field\_definitions.update](https://developer.adobe.com/frameio/api/current/#tag/Files/operation/metadata.field_definitions.update). Rate Limits: 10 calls per 1.00 minute(s) per account\_user Reference: https://next.developer.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) ### Headers - `api-version` (enum, required) - Allowed values: `experimental` ### 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) ### 409 Conflict Error Conflict - `errors` (list of ConflictErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable content - `errors` (list of UnprocessableContentErrorsItems, required) ### 429 Too Many Requests Error Too many requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### UpdateFieldDefinitionParamsData - `field_type`: `date` (UpdateDateDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingDateFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `long_text` (UpdateLongTextDefinitionParams) - `name` (string, optional) — Field definition name - `field_type`: `number` (UpdateNumberDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingNumberFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `rating` (UpdateRatingDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingRatingFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `select` (UpdateSelectDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `select_multi` (UpdateSelectMultiDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectMultiFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `text` (UpdateTextDefinitionParams) - `name` (string, optional) — Field definition name - `field_type`: `toggle` (UpdateToggleDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingToggleFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `user_multi` (UpdateUserMultiDefinitionParams) - `field_configuration` (UpdateFieldDefinitionParamsDataDiscriminatorMappingUserMultiFieldConfiguration, optional) - `name` (string, optional) — Field definition name - `field_type`: `user_single` (UpdateUserSingleDefinitionParams) - `field_configuration` (UpdateUserSingleDefinitionParamsFieldConfiguration, optional) - `name` (string, optional) — Field definition name ### FieldDefinition - `field_type`: `date` (DateDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingDateFieldConfiguration, required) - `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 - `field_type`: `long_text` (LongTextDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingLongTextFieldConfiguration, required) - `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 - `field_type`: `number` (NumberDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingNumberFieldConfiguration, required) - `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 - `field_type`: `rating` (RatingDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingRatingFieldConfiguration, required) - `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 - `field_type`: `select` (SelectDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingSelectFieldConfiguration, required) - `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 - `field_type`: `select_multi` (SelectMultiDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingSelectMultiFieldConfiguration, required) - `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 - `field_type`: `text` (TextDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingTextFieldConfiguration, required) - `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 - `field_type`: `toggle` (ToggleDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingToggleFieldConfiguration, required) - `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 - `field_type`: `user_multi` (UserMultiDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingUserMultiFieldConfiguration, required) - `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 - `field_type`: `user_single` (UserSingleDefinition) - `created_at` (string, required) — Created Timestamp - `creator_id` (string, required) — Field definition creator ID - `field_configuration` (FieldDefinitionDiscriminatorMappingUserSingleFieldConfiguration, required) - `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 ### 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) ### ConflictErrorsItems - `detail` (string, required) - `source` (ConflictErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableContentErrorsItems - `detail` (string, required) - `source` (UnprocessableContentErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### UpdateFieldDefinitionParamsDataDiscriminatorMappingDateFieldConfiguration - `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` ### UpdateFieldDefinitionParamsDataDiscriminatorMappingNumberFieldConfiguration - `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 ### UpdateFieldDefinitionParamsDataDiscriminatorMappingRatingFieldConfiguration - `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` ### UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectFieldConfiguration - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view - `options` (list of UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectFieldConfigurationOptionsItems, optional) ### UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectMultiFieldConfiguration - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view - `options` (list of UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectMultiFieldConfigurationOptionsItems, optional) ### UpdateFieldDefinitionParamsDataDiscriminatorMappingToggleFieldConfiguration - `color` (string, optional) — Color value hex code. ex: #fbd400 ### UpdateFieldDefinitionParamsDataDiscriminatorMappingUserMultiFieldConfiguration - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) - `custom_members` (list of UpdateFieldDefinitionParamsDataDiscriminatorMappingUserMultiFieldConfigurationCustomMembersItems, optional) ### UpdateUserSingleDefinitionParamsFieldConfiguration - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) - `custom_members` (list of UpdateUserSingleDefinitionParamsFieldConfigurationCustomMembersItems, optional) ### FieldDefinitionDiscriminatorMappingDateFieldConfiguration - `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` ### FieldDefinitionDiscriminatorMappingLongTextFieldConfiguration ### FieldDefinitionDiscriminatorMappingNumberFieldConfiguration - `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` ### FieldDefinitionDiscriminatorMappingRatingFieldConfiguration - `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` ### FieldDefinitionDiscriminatorMappingSelectFieldConfiguration - `options` (list of FieldDefinitionDiscriminatorMappingSelectFieldConfigurationOptionsItems, required) - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view ### FieldDefinitionDiscriminatorMappingSelectMultiFieldConfiguration - `options` (list of FieldDefinitionDiscriminatorMappingSelectMultiFieldConfigurationOptionsItems, required) - `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view ### FieldDefinitionDiscriminatorMappingTextFieldConfiguration ### FieldDefinitionDiscriminatorMappingToggleFieldConfiguration - `color` (string, required, nullable) — Color value hex code. ex: #fbd400 ### FieldDefinitionDiscriminatorMappingUserMultiFieldConfiguration - `custom_members` (list of FieldDefinitionDiscriminatorMappingUserMultiFieldConfigurationCustomMembersItems, required) - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) ### FieldDefinitionDiscriminatorMappingUserSingleFieldConfiguration - `custom_members` (list of FieldDefinitionDiscriminatorMappingUserSingleFieldConfigurationCustomMembersItems, required) - `member_options_type` (enum, required) - Allowed values: `all_project_members`, `custom` - `notify_members` (boolean, required) ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### ConflictErrorsItemsSource - `pointer` (string, optional) ### UnprocessableContentErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ### UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400 ### UpdateFieldDefinitionParamsDataDiscriminatorMappingSelectMultiFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400 ### UpdateFieldDefinitionParamsDataDiscriminatorMappingUserMultiFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### UpdateUserSingleDefinitionParamsFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### FieldDefinitionDiscriminatorMappingSelectFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400 - `id` (string, optional) ### FieldDefinitionDiscriminatorMappingSelectMultiFieldConfigurationOptionsItems - `display_name` (string, required) — Option display name - `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400 - `id` (string, optional) ### FieldDefinitionDiscriminatorMappingUserMultiFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### FieldDefinitionDiscriminatorMappingUserSingleFieldConfigurationCustomMembersItems - `id` (string, required) — User Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ## Examples **Request** ```json { "data": { "field_type": "select", "field_configuration": { "enable_add_new": false, "options": [ { "display_name": "Option 1" }, { "display_name": "Option 2" } ] }, "name": "Updated-Field-Name" } } ``` **Response** ```json { "data": { "field_type": "select", "created_at": "2024-01-25T19:18:29.614189Z", "creator_id": "bc4920f6-cba7-4e53-8e36-d99caf99200a", "field_configuration": { "options": [ { "display_name": "Option 1", "id": "071d6fb3-ffd2-4e71-8eeb-65c3e4db56f2" }, { "display_name": "Option 2", "id": "c146457c-eb1b-4f67-a3cf-47755cd2630b" } ], "enable_add_new": false }, "id": "af27eacf-f82b-4729-8879-8d034df97b64", "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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe" payload = { "data": { "field_type": "select", "field_configuration": { "enable_add_new": False, "options": [{ "display_name": "Option 1" }, { "display_name": "Option 2" }] }, "name": "Updated-Field-Name" } } headers = { "api-version": "experimental", "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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe'; const options = { method: 'PATCH', headers: { 'api-version': 'experimental', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{"data":{"field_type":"select","field_configuration":{"enable_add_new":false,"options":[{"display_name":"Option 1"},{"display_name":"Option 2"}]},"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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe" payload := strings.NewReader("{\n \"data\": {\n \"field_type\": \"select\",\n \"field_configuration\": {\n \"enable_add_new\": false,\n \"options\": [\n {\n \"display_name\": \"Option 1\"\n },\n {\n \"display_name\": \"Option 2\"\n }\n ]\n },\n \"name\": \"Updated-Field-Name\"\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("api-version", "experimental") 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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["api-version"] = 'experimental' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"field_type\": \"select\",\n \"field_configuration\": {\n \"enable_add_new\": false,\n \"options\": [\n {\n \"display_name\": \"Option 1\"\n },\n {\n \"display_name\": \"Option 2\"\n }\n ]\n },\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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe") .header("api-version", "experimental") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"field_type\": \"select\",\n \"field_configuration\": {\n \"enable_add_new\": false,\n \"options\": [\n {\n \"display_name\": \"Option 1\"\n },\n {\n \"display_name\": \"Option 2\"\n }\n ]\n },\n \"name\": \"Updated-Field-Name\"\n }\n}") .asString(); ``` ```php request('PATCH', 'https://api.frame.io/v4/accounts/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe', [ 'body' => '{ "data": { "field_type": "select", "field_configuration": { "enable_add_new": false, "options": [ { "display_name": "Option 1" }, { "display_name": "Option 2" } ] }, "name": "Updated-Field-Name" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'api-version' => 'experimental', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe"); var request = new RestRequest(Method.PATCH); request.AddHeader("api-version", "experimental"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"field_type\": \"select\",\n \"field_configuration\": {\n \"enable_add_new\": false,\n \"options\": [\n {\n \"display_name\": \"Option 1\"\n },\n {\n \"display_name\": \"Option 2\"\n }\n ]\n },\n \"name\": \"Updated-Field-Name\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "api-version": "experimental", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": [ "field_type": "select", "field_configuration": [ "enable_add_new": false, "options": [["display_name": "Option 1"], ["display_name": "Option 2"]] ], "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/8c787f6f-44a4-41ea-946c-847f345c5bbe/metadata/field_definitions/c679ef3d-e3a5-4836-98b9-af4c57d47fbe")! 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() ```