# addCustomAttributeOptions

Mutation

Add options to a creator select field; names the field already has are skipped.

Available to agents as MCP tool `addCustomAttributeOptions` — see [Write tools](/api/v2/docs/mcp/write-tools#add-custom-attribute-options).

## Arguments

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `key` | `String!` | Yes | — | Key of a SINGLE_SELECT_V3 or MULTIPLE_SELECT_V2 creator field, as `customAttributeSchemas(entity: CREATOR)` lists it. The `labels` key is refused; use `createLabels`. |
| `names` | `[String!]!` | Yes | — | Option names to add, 1 to 100, each at most 255 characters once trimmed. A field holds at most 500 options. |

## Returns

| Name | Type | Description |
| --- | --- | --- |
| `addedOptionIds` | `[ID!]!` | IDs of the options this call created, in submission order. Empty when every name existed. |
| `schema` | [`CustomAttributeSchema`](/api/v2/docs/types/custom-attribute-schema) | The field with all its options. Null when userErrors is non-empty. |
| `skippedNames` | `[String!]!` | Submitted names the field already had, trimmed, in submission order. Nothing was added for them. |
| `userErrors` | [`[UserError!]!`](/api/v2/docs/types/user-error) | Errors that refused the request: an unknown, read-only or non-select key, the `labels` key, unusable names, or the option cap. Empty on success. |

## Examples

### Add options to a creator select field

Add option names to a creator select field; names it already has are skipped.

```graphql
mutation AddCustomAttributeOptionsDefault($key: String!, $names: [String!]!) {
  addCustomAttributeOptions(key: $key, names: $names) {
    schema {
      key
      options {
        id
        name
      }
    }
    addedOptionIds
    skippedNames
    userErrors {
      field
      message
    }
  }
}
```

Variables:

```json
{
  "key": "collaboration_status",
  "names": [
    "Paused",
    "Contracted"
  ]
}
```

Response — HTTP 200:

```json
{
  "data": {
    "addCustomAttributeOptions": {
      "schema": {
        "key": "collaboration_status",
        "options": [
          {
            "id": "249fe558-15b1-58bb-b8b6-be069c08c332",
            "name": "To Review"
          },
          {
            "id": "1e1f4791-46a4-5421-8302-138700a0f90b",
            "name": "Outreached"
          },
          {
            "id": "df768859-ddd1-5582-ab50-cf5710c6ef1e",
            "name": "In Discussion"
          },
          {
            "id": "f90a4389-a120-5872-9d2c-7eef54c676a6",
            "name": "Interested"
          },
          {
            "id": "bdb6847c-758f-54d1-8e40-e4893ebc8ce0",
            "name": "Contracted"
          },
          {
            "id": "6d51eb54-bc20-527e-a561-f63e909239e4",
            "name": "Active"
          },
          {
            "id": "9db0dd62-8799-5cfd-97c7-f0830bd3117f",
            "name": "Not Interested"
          },
          {
            "id": "4dd6773f-39d2-5c4f-8fce-3cd03817373c",
            "name": "Not a Fit"
          },
          {
            "id": "e497b4c2-d3e9-5e50-bc9f-126226cb7f41",
            "name": "Not Responsive"
          },
          {
            "id": "57a5e473-0540-5009-9e2d-d4b31778f080",
            "name": "Paused"
          }
        ]
      },
      "addedOptionIds": [
        "57a5e473-0540-5009-9e2d-d4b31778f080"
      ],
      "skippedNames": [
        "Contracted"
      ],
      "userErrors": []
    }
  }
}
```