> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Affinity: V2 Lists List ID Fields Field ID Dropdown

> Create a dropdown option for a List Field. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Create a dropdown option for a List Field.

<Info>
  Tool ID: `affinity_v2_lists_list_id_fields_field_id_dropdown_options_post`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_lists_list_id_fields_field_id_dropdown_options_post',
  {
    "listId": 123,
    "fieldId": "field_123",
    "type": "dropdown",
    "text": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute affinity_v2_lists_list_id_fields_field_id_dropdown_options_post --input '{
  "listId": 123,
  "fieldId": "field_123",
  "type": "dropdown",
  "text": "example"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get affinity_v2_lists_list_id_fields_field_id_dropdown_options_post --json` for the complete live contract.

## Input reference

Create a dropdown option for a List Field.

| Name                     | Type                                                                      | Required | Default | Details                                                                                                                                                                                                                               |
| ------------------------ | ------------------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.listId`         | `integer`                                                                 | Yes      | —       | List ID Format: `int64`. Minimum: 1. Maximum: 9007199254740991.                                                                                                                                                                       |
| `payload.fieldId`        | `string`                                                                  | Yes      | —       | Field ID                                                                                                                                                                                                                              |
| `payload.type`           | `"dropdown" \| "ranked-dropdown" \| "status-dropdown"`                    | Yes      | —       | —                                                                                                                                                                                                                                     |
| `payload.text`           | `string`                                                                  | Yes      | —       | Dropdown option text Minimum length: 1. Maximum length: 255.                                                                                                                                                                          |
| `payload.rank`           | `integer`                                                                 | No       | —       | Dropdown option rank (sort order) Format: `int32`. Minimum: 0. Maximum: 2147483647.                                                                                                                                                   |
| `payload.color`          | `"white" \| "gray" \| "blue" \| "green" \| "purple" \| "orange" \| "red"` | No       | —       | Dropdown option color Allowed: `white`, `gray`, `blue`, `green`, `purple`, `orange`, `red`.                                                                                                                                           |
| `payload.statusCategory` | `"open" \| "won" \| "lost" \| "on-hold"`                                  | No       | —       | Dropdown option's status category Allowed: `open`, `won`, `lost`, `on-hold`.                                                                                                                                                          |
| `payload.winRate`        | `integer`                                                                 | No       | —       | The user-designated probability that an entity in this status will progress to a `won` status. Only valid when `statusCategory` is `open`. Must be an integer between 0 and 100 inclusive. Format: `int32`. Minimum: 0. Maximum: 100. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Create a dropdown option for a List Field.",
    "properties": {
      "listId": {
        "type": "integer",
        "description": "List ID",
        "minimum": 1,
        "maximum": 9007199254740991,
        "format": "int64"
      },
      "fieldId": {
        "type": "string",
        "description": "Field ID"
      },
      "type": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "dropdown",
              "ranked-dropdown"
            ]
          },
          {
            "type": "string",
            "description": "The type of dropdown option",
            "const": "status-dropdown"
          }
        ]
      },
      "text": {
        "type": "string",
        "description": "Dropdown option text",
        "minLength": 1,
        "maxLength": 255
      },
      "rank": {
        "type": "integer",
        "description": "Dropdown option rank (sort order)",
        "minimum": 0,
        "maximum": 2147483647,
        "format": "int32"
      },
      "color": {
        "type": "string",
        "description": "Dropdown option color",
        "enum": [
          "white",
          "gray",
          "blue",
          "green",
          "purple",
          "orange",
          "red"
        ]
      },
      "statusCategory": {
        "type": "string",
        "description": "Dropdown option's status category",
        "enum": [
          "open",
          "won",
          "lost",
          "on-hold"
        ]
      },
      "winRate": {
        "type": "integer",
        "description": "The user-designated probability that an entity in this status will progress to a `won` status. Only valid when `statusCategory` is `open`. Must be an integer between 0 and 100 inclusive.",
        "minimum": 0,
        "maximum": 100,
        "format": "int32"
      }
    },
    "required": [
      "listId",
      "fieldId",
      "type",
      "text"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name                         | Type                                                                              | Required | Default | Details                                                 |
| ---------------------------- | --------------------------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------- |
| `result.data`                | `object`                                                                          | Yes      | —       | —                                                       |
| `result.data.id`             | `integer`                                                                         | Yes      | —       | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.text`           | `string`                                                                          | Yes      | —       | —                                                       |
| `result.data.type`           | `"dropdown" \| "ranked-dropdown" \| "status-dropdown"`                            | Yes      | —       | —                                                       |
| `result.data.rank`           | `integer`                                                                         | No       | —       | Format: `int32`. Minimum: 0. Maximum: 2147483647.       |
| `result.data.color`          | `"white" \| "gray" \| "blue" \| "green" \| "purple" \| "orange" \| "red" \| null` | No       | —       | —                                                       |
| `result.data.statusCategory` | `"open" \| "won" \| "lost" \| "on-hold"`                                          | No       | —       | Allowed: `open`, `won`, `lost`, `on-hold`.              |
| `result.data.winRate`        | `integer \| null`                                                                 | No       | —       | Format: `int32`. Minimum: 0. Maximum: 100.              |
| `result.meta`                | `object`                                                                          | No       | —       | —                                                       |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991,
            "format": "int64"
          },
          "text": {
            "type": "string"
          },
          "type": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "dropdown",
                  "ranked-dropdown"
                ]
              },
              {
                "type": "string",
                "const": "status-dropdown"
              }
            ]
          },
          "rank": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2147483647,
            "format": "int32"
          },
          "color": {
            "anyOf": [
              {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "white",
                  "gray",
                  "blue",
                  "green",
                  "purple",
                  "orange",
                  "red",
                  null
                ]
              },
              {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "white",
                  "gray",
                  "blue",
                  "green",
                  "purple",
                  "orange",
                  "red",
                  null
                ]
              }
            ]
          },
          "statusCategory": {
            "type": "string",
            "enum": [
              "open",
              "won",
              "lost",
              "on-hold"
            ]
          },
          "winRate": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 100,
            "format": "int32"
          }
        },
        "required": [
          "id",
          "text",
          "type"
        ],
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "minimum": 1,
                "maximum": 9007199254740991,
                "format": "int64"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "text"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "minimum": 1,
                "maximum": 9007199254740991,
                "format": "int64"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "text"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "minimum": 1,
                "maximum": 9007199254740991,
                "format": "int64"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "text"
            ],
            "additionalProperties": false
          }
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Affinity provider guide](/docs/providers/affinity/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)
