To create a simple custom field, use this base mutation:
mutation CreateCustomField {
createCustomField(
input: {
type: "CUSTOM_FIELD_TYPE",
name: "YOUR_CUSTOM_FIELD_NAME"
}
) {
name
id
type
uid
updatedAt
}
}
These field types can be created with the basic mutation:
Type | Description | Example Values |
---|---|---|
TEXT_SINGLE | Single-line text field | "Project Name" |
URL | URL field | "Website URL" |
FILE | File attachment field | "Documents" |
COUNTRY | Country selector | "Country" |
SELECT_SINGLE | Single-select dropdown | "Priority" |
TEXT_MULTI | Multi-line text field | "Description" |
PHONE | Phone number field | "Contact Number" |
EMAIL | Email address field | "Support Email" |
SELECT_MULTI | Multi-select dropdown | "Tags" |
LOCATION | Geographic location | "Meeting Point" |
CHECKBOX | Boolean checkbox | "Approved" |
PERCENT | Percentage value | "Completion" |
X-Bloo-Token-ID
X-Bloo-Token-Secret
X-Bloo-Company-ID
X-Bloo-Project-ID
(for project-specific fields)mutation CreateCurrencyField {
createCustomField(
input: {
type: "CURRENCY",
name: "Budget",
currency: "USD"
}
) {
id
currency
# ... other fields
}
}
mutation CreateDateField {
createCustomField(
input: {
type: "DATE",
name: "Launch Date",
isDueDate: true
}
) {
id
isDueDate
# ... other fields
}
}
mutation CreateRatingField {
createCustomField(
input: {
type: "RATING",
name: "Satisfaction",
max: 5
}
) {
id
max
# ... other fields
}
}
mutation CreateNumberField {
createCustomField(
input: {
type: "NUMBER",
name: "Quantity",
min: 0,
max: 100
}
) {
id
min
max
# ... other fields
}
}
mutation CreateUniqueIdField {
createCustomField(
input: {
type: "UNIQUE_ID",
name: "Order ID",
prefix: "ORD-"
}
) {
id
prefix
# ... other fields
}
}
For SELECT_SINGLE
and SELECT_MULTI
types, create options:
mutation CreateFieldOption {
createCustomFieldOption(
input: {
customFieldId: "FIELD_ID",
title: "High Priority",
color: "#ff0000",
position: 1.0
}
) {
id
title
color
}
}
mutation CreateMultipleOptions {
createCustomFieldOptions(
input: {
customFieldId: "FIELD_ID",
customFieldOptions: [
{title: "Bug", color: "#ff0000"},
{title: "Feature", color: "#00ff00"},
{title: "Improvement", position: 2.5}
]
}
) {
id
title
position
}
}
The following field types are supported in the API but require additional configuration:
TIME_DURATION
- For tracking time estimates and actualsLOOKUP
- For referencing data from other recordsREFERENCE
- For linking to other recordsFORMULA
- For calculated fields based on other values#RRGGBB
){
"data": {
"createCustomField": {
"id": "cf_2XnZk4sM3v8qLtBw",
"name": "Project Budget",
"type": "CURRENCY",
"currency": "USD",
"uid": "budget",
"updatedAt": "2024-02-15T08:30:45Z"
}
}
}