> 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-create/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server.

# Create account level field definitions

POST https://api.frame.io/v4/accounts/{account_id}/metadata/field_definitions
Content-Type: application/json

Create account level 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-create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `account_id` (string, required)

### Body (application/json)

This endpoint expects a CreateFieldDefinitionParams.

- `data` (CreateFieldDefinitionParamsData, optional)

## Response

### 201

Created

- `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

### CreateFieldDefinitionParamsData

### 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)

### TextDefinitionParams

- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### LongTextDefinitionParams

- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### RatingDefinitionParams

- `field_configuration` (RatingDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### NumberDefinitionParams

- `field_configuration` (NumberDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### ToggleDefinitionParams

- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name
- `field_configuration` (ToggleDefinitionParamsFieldConfiguration, optional)

### DateDefinitionParams

- `field_configuration` (DateDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### SelectDefinitionParams

- `field_configuration` (SelectDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### SelectMultiDefinitionParams

- `field_configuration` (SelectMultiDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### UserSingleDefinitionParams

- `field_configuration` (UserSingleDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — Field definition name

### UserMultiDefinitionParams

- `field_configuration` (UserMultiDefinitionParamsFieldConfiguration, required)
- `field_type` (enum, required) — Field type
  - Allowed values: `text`, `long_text`, `select`, `select_multi`, `rating`, `number`, `toggle`, `date`, `user_multi`, `user_single`
- `name` (string, required) — 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)

### RatingDefinitionParamsFieldConfiguration

- `max_value` (integer, required)
- `color` (string, optional) — Color value hex code for the `style` icon symbols. ex: #fbd400
- `style` (enum, optional) — Field type
  - Allowed values: `star`, `heart`, `thumbs_up`

### NumberDefinitionParamsFieldConfiguration

- `scale` (integer, required) — Number scale. Indicates the number of decimal places of precision for the number value
- `number_format` (enum, optional) — Number format
  - Allowed values: `bitrate`, `bits`, `duration`, `framerate`, `frequency`, `storage`, `timecode`

### ToggleDefinitionParamsFieldConfiguration

- `color` (string, optional) — Color value hex code. ex: #fbd400

### DateDefinitionParamsFieldConfiguration

- `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`

### SelectDefinitionParamsFieldConfiguration

- `options` (list of SelectDefinitionParamsFieldConfigurationOptionsItems, required)
- `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view

### SelectMultiDefinitionParamsFieldConfiguration

- `options` (list of SelectMultiDefinitionParamsFieldConfigurationOptionsItems, required)
- `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view

### UserSingleDefinitionParamsFieldConfiguration

- `member_options_type` (enum, required)
  - Allowed values: `all_project_members`, `custom`
- `notify_members` (boolean, required)
- `custom_members` (list of UserSingleDefinitionParamsFieldConfigurationCustomMembersItems, optional)

### UserMultiDefinitionParamsFieldConfiguration

- `member_options_type` (enum, required)
  - Allowed values: `all_project_members`, `custom`
- `notify_members` (boolean, required)
- `custom_members` (list of UserMultiDefinitionParamsFieldConfigurationCustomMembersItems, 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)

### SelectDefinitionParamsFieldConfigurationOptionsItems

- `display_name` (string, required) — Option display name
- `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400

### SelectMultiDefinitionParamsFieldConfigurationOptionsItems

- `display_name` (string, required) — Option display name
- `color` (string, optional) — Color value hex code for the `display_name`. ex: #fbd400

### UserSingleDefinitionParamsFieldConfigurationCustomMembersItems

- `id` (string, required) — User Id
- `type` (enum, required)
  - Allowed values: `user`, `account_user_group`

### UserMultiDefinitionParamsFieldConfigurationCustomMembersItems

- `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": "Fields definition 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/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions"

payload = { "data": {
        "field_type": "select",
        "name": "Fields definition name"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"field_type":"select","name":"Fields definition 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/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions"

	payload := strings.NewReader("{\n  \"data\": {\n    \"field_type\": \"select\",\n    \"name\": \"Fields definition name\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"field_type\": \"select\",\n    \"name\": \"Fields definition 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<String> response = Unirest.post("https://api.frame.io/v4/accounts/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"field_type\": \"select\",\n    \"name\": \"Fields definition name\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.frame.io/v4/accounts/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions', [
  'body' => '{
  "data": {
    "field_type": "select",
    "name": "Fields definition name"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"field_type\": \"select\",\n    \"name\": \"Fields definition name\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    "field_type": "select",
    "name": "Fields definition name"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/7b415b37-de58-40ed-8e1f-8e7289d18598/metadata/field_definitions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```