Mutation

createCustomAttributeSchema

Create a creator custom attribute field of a value or select type. The key is derived from the name.

MCP: createCustomAttributeSchema

Arguments

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

name String! required: Display name, at most 100 characters. It must differ from every creator field name, ignoring case and surrounding whitespace. Built-in names such as Labels are refused.
options [String!]: Initial option names for SINGLE_SELECT_V3 and MULTIPLE_SELECT_V2, at most 100, each at most 255 characters. Repeated names collapse. Omit it for other types.
type CustomAttributeType! required: Value type. Only TEXT, URL, EMAIL, PHONE, NUMBER, BOOLEAN, DATE, DATETIME, TEXT_LIST, NUMBER_LIST, BOOLEAN_LIST, DATE_LIST, DATETIME_LIST, SINGLE_SELECT_V3, MULTIPLE_SELECT_V2 can be created; any other type is a userError on type.
BOOLEAN: True/false value.
BOOLEAN_LIST: List of true/false values.
DATE: Calendar date value (ISO 8601, no time component).
DATETIME: Date-and-time value (ISO 8601).
DATETIME_LIST: List of date-and-time values (ISO 8601).
DATE_LIST: List of calendar date values (ISO 8601, no time component).
EMAIL: Email address value.
MULTIPLE_SELECT: Multiple choices from a predefined option list; the stored value is an array of option IDs.
MULTIPLE_SELECT_V2: Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
NUMBER: Numeric value.
NUMBER_LIST: List of numeric values.
PHONE: Phone number value.
SHIPPING_ADDRESS: Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
SINGLE_SELECT_V2: Single choice from a predefined option list; the stored value is an option ID.
SINGLE_SELECT_V3: Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
TEXT: Free-form text value.
TEXT_LIST: List of free-form text values.
URL: URL value.

Returns

schema CustomAttributeSchema: The created field, as customAttributeSchemas(entity: CREATOR) lists it. Null when userErrors is non-empty.
aiGenerated Boolean!: True when this attribute's value is produced by an AI Filter. For AI-generated attributes, an item's aiFilterReasons entry with the matching key carries the model's explanation for the value.
key String!: Key used in the customAttributes object.
name String!: Human-readable display name.
options [CustomAttributeOption!]: Available options for select-type attributes. When present, customAttributes values are option IDs that map to these options. When null, values are stored directly (text, numbers, dates, etc.).
id ID!: Unique identifier. Match this against values in customAttributes. For the ITEM collections schema this is a Collection's customAttributeOptionId, not its id.
name String!: Human-readable display name.
type CustomAttributeType!: Custom attribute field type.
BOOLEAN: True/false value.
BOOLEAN_LIST: List of true/false values.
DATE: Calendar date value (ISO 8601, no time component).
DATETIME: Date-and-time value (ISO 8601).
DATETIME_LIST: List of date-and-time values (ISO 8601).
DATE_LIST: List of calendar date values (ISO 8601, no time component).
EMAIL: Email address value.
MULTIPLE_SELECT: Multiple choices from a predefined option list; the stored value is an array of option IDs.
MULTIPLE_SELECT_V2: Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
NUMBER: Numeric value.
NUMBER_LIST: List of numeric values.
PHONE: Phone number value.
SHIPPING_ADDRESS: Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
SINGLE_SELECT_V2: Single choice from a predefined option list; the stored value is an option ID.
SINGLE_SELECT_V3: Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
TEXT: Free-form text value.
TEXT_LIST: List of free-form text values.
URL: URL value.
userErrors [UserError!]!: Errors that refused the request, on the input at fault: a blank, long, taken or built-in name, a type that cannot be created, unusable options, or the 250-field workspace cap on base (built-in fields do not count). Empty on success.
field [String!]: Path to the input field that caused the error.
message String!: The error message.

mutation CreateCustomAttributeSchemaDefault($name: String!, $type: CustomAttributeType!, $options: [String!]) { createCustomAttributeSchema(name: $name, type: $type, options: $options) { schema { key name type options { id name } } userErrors { field message } } }

{ "data": { "createCustomAttributeSchema": { "schema": { "key": "creator_tier", "name": "Creator Tier", "type": "SINGLE_SELECT_V3", "options": [ { "id": "e0ba7c8b-59c6-56ff-8aed-f148d120e16b", "name": "Gold" }, { "id": "741f26c9-bcee-5080-8331-0ce51d5713b0", "name": "Silver" } ] }, "userErrors": [] } } }