> ## Documentation Index > Fetch the complete documentation index at: https://developers.wrike.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Custom Field (Account) Create custom field in specified account. Scopes: Default, wsReadWrite # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Wrike API", "version": "4.0" }, "servers": [ { "url": "https://www.wrike.com/api/v4" }, { "url": "https://app-eu.wrike.com/api/v4" }, { "url": "https://app-us2.wrike.com/api/v4" } ], "paths": { "/customfields": { "post": { "tags": [ "Custom Fields" ], "summary": "Create Custom Field (Account)", "description": "Create custom field in specified account.\n\nScopes: Default, wsReadWrite", "operationId": "POST:/customfields/empty", "parameters": [ { "name": "title", "in": "query", "description": "Custom field title", "required": true, "schema": { "type": "string", "description": "Custom field title" } }, { "name": "type", "in": "query", "description": "Custom field type\n* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field", "required": true, "schema": { "$ref": "#/components/schemas/CustomFieldType" } }, { "name": "spaceId", "in": "query", "description": "Custom field space ID", "required": false, "schema": { "$ref": "#/components/schemas/SpaceId" } }, { "name": "sharing", "in": "query", "description": "Custom field access settings", "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSharing" } } } }, { "name": "shareds", "in": "query", "description": "Users to share custom field with. Parameter is obsolete, use 'sharing' instead", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Users to share custom field with. Parameter is obsolete, use 'sharing' instead", "items": { "$ref": "#/components/schemas/UserId" } } } } }, { "name": "settings", "in": "query", "description": "Custom field settings", "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSettingsParam" } } } }, { "name": "description", "in": "query", "description": "Custom field description", "required": false, "schema": { "type": "string", "description": "Custom field description" } } ], "responses": { "2XX": { "description": "success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDescription" } }, "kind": { "$ref": "#/components/schemas/ResponseKind" } } } } } }, "4XX": { "description": "client-side error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "5XX": { "description": "server-side error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTP": [] } ] } } }, "components": { "schemas": { "ResponseKind": { "type": "string", "enum": [ "accounts", "users", "contacts", "assets", "eDiscoveryReport", "folders", "folderTree", "tasks", "taskIds", "timelogs", "timelogCategories", "timelogLockPeriods", "timetrackerTimers", "comments", "attachments", "url", "version", "dataExport", "dataExportSchema", "auditLog", "accessRoles", "stream", "changes", "posts", "mailSettings", "integrationInfo", "gmailIntegrationSettings", "workTypesForIntegrations", "ids", "backups", "domains", "dependencies", "workflows", "workschedules", "workscheduleExclusions", "workscheduleUserExclusions", "customfields", "customfieldIds", "customstatuses", "invitations", "notifications", "jobroles", "placeholders", "groups", "session", "dashboards", "widgets", "taskCreationSettings", "colors", "experiments", "topics", "topicComments", "webhooks", "reviews", "boards", "textSearch", "chatChannels", "chatMessages", "forms", "requestForms", "request", "report", "platformWidgets", "platformWidgetInstances", "spaces", "pdf", "customerSatisfaction", "asyncJob", "approvals", "highlights", "highlightsList", "highlightsSettings", "highlightsCard", "timesheet", "timesheetRow", "timesheetSubmissionRule", "mobileFeatures", "mobileSettings", "folderBlueprintTree", "taskBlueprintTree", "feedback", "timeline_snapshot", "contactIds", "bookings", "integrateThreshold", "hourlyRatesProvision", "hourlyRates", "projectTeamMembers", "contactsHistory", "tasksHistory", "foldersHistory", "activityDigest", "workItemTemplates", "workTemplates", "workItemMetadata", "workItem", "customItemTypes", "verificationCode", "views", "listView", "tableView", "userTypes", "reactions", "externalRequesters", "workscheduleCapacityOverrides", "userCapacityOverrides", "userCapacityExclusions", "rollups", "requestFormPrefill", "cascadingFieldSettings" ] }, "CustomFieldApplicableEntityType": { "type": "string", "description": "* `User`\n* `WorkItem`", "enum": [ "User", "WorkItem" ] }, "CustomFieldId": { "pattern": "^([A-Z0-9]){16}$", "type": "string" }, "CustomFieldSettings": { "required": [ "readOnly" ], "type": "object", "properties": { "optionColorsEnabled": { "type": "boolean", "description": "Is colors for options enabled (only for DropDown and MultipleSelect type). Use parameter 'options' to specify colors" }, "linkToDatabaseInfo": { "$ref": "#/components/schemas/CustomFieldLinkToDatabaseField" }, "timezone": { "type": "string", "description": "Timezone Id, e.g 'America/New_York' (only for Date type)" }, "values": { "type": "array", "description": "Dropdown values without colors (only for DropDown and MultipleSelect type)", "items": { "type": "string" } }, "aggregation": { "$ref": "#/components/schemas/CustomFieldAggregationType" }, "readOnly": { "type": "boolean", "description": "Is field value read only" }, "allowOtherValues": { "type": "boolean", "description": "Allow users to input other values (only for DropDown type)", "default": "true" }, "useThousandsSeparator": { "type": "boolean", "description": "Use thousands separator (only for Numeric type)", "default": "false" }, "decimalPlaces": { "type": "number", "description": "Decimal places (only for Numeric, Percentage and Currency types)", "default": "2" }, "options": { "type": "array", "description": "Dropdown options with colors (only for DropDown and MultipleSelect type). Array of objects:\n{\"value\": \"string\", \"color\": \"enum: Brown, Red, Purple, Indigo, DarkBlue, Blue, Turquoise, DarkCyan, Green, YellowGreen, Yellow, Orange, Gray, DarkRed\"}\n", "items": { "$ref": "#/components/schemas/CustomFieldDropdownOption" } }, "currency": { "$ref": "#/components/schemas/CustomFieldCurrency" }, "allowTime": { "type": "boolean", "description": "Allow users to input time (only for Date type)" }, "mirrorInfo": { "$ref": "#/components/schemas/CustomFieldMirrorField" }, "applicableEntityTypes": { "type": "array", "description": "Applicable entity types", "items": { "$ref": "#/components/schemas/CustomFieldApplicableEntityType" }, "default": "WorkItem" }, "contacts": { "type": "array", "description": "Allowed users or invitations (only for Users type)", "items": { "$ref": "#/components/schemas/UserId" } }, "inheritanceType": { "type": "string", "enum": [ "All", "Projects", "Folders" ] } } }, "CustomFieldAggregationType": { "type": "string", "description": "* `Average`\n* `Sum`\n* `None`", "enum": [ "Average", "Sum", "None" ] }, "CustomFieldLinkToDatabaseMirrorFieldParam": { "required": [ "dataHubFieldId", "customFieldName" ], "type": "object", "properties": { "dataHubFieldId": { "type": "string", "description": "DataHub field identifier in DataHub Public API format" }, "customFieldName": { "type": "string", "description": "Custom field name for this mirror" } } }, "CustomFieldSharing": { "type": "object", "properties": { "readerIds": { "type": "array", "description": "Users who can see the field.
\n\n", "items": { "$ref": "#/components/schemas/UserId" } }, "spaceReaders": { "$ref": "#/components/schemas/CustomFieldSharingSpaceMembership" }, "spaceWriters": { "$ref": "#/components/schemas/CustomFieldSharingSpaceMembership" }, "writerIds": { "type": "array", "description": "Users who can edit field values.
\n\n
\nVarious system actions (request form submission, automation action...) are not affected by this setting\n", "items": { "$ref": "#/components/schemas/UserId" } } } }, "CustomFieldDescription": { "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/CustomFieldSettings" }, "archivedOn": { "type": "string", "description": "Date when the custom field was archived, formatted as ISO local date
Format: yyyy-MM-dd'T'HH:mm:ss'Z'" }, "sharedIds": { "type": "array", "description": "Users with whom the custom field is shared. Field is obsolete, use 'sharing' to get more relevant access settings", "items": { "$ref": "#/components/schemas/UserId" } }, "description": { "type": "string", "description": "Custom field description" }, "title": { "type": "string", "description": "Custom field title" }, "type": { "$ref": "#/components/schemas/CustomFieldType" }, "sharing": { "$ref": "#/components/schemas/CustomFieldSharing" }, "dataUsageStatistics": { "$ref": "#/components/schemas/DataUsageStatistics" }, "accountId": { "$ref": "#/components/schemas/AccountId" }, "spaceId": { "$ref": "#/components/schemas/SpaceId" }, "archived": { "type": "boolean", "description": "Whether the custom field is archived" }, "id": { "$ref": "#/components/schemas/CustomFieldId" }, "archivedBy": { "type": "string", "description": "User ID" } } }, "CustomFieldLinkToDatabaseMirrorField": { "required": [ "dataHubFieldId", "customFieldId" ], "type": "object", "properties": { "dataHubFieldId": { "type": "string", "description": "DataHub field identifier in DataHub Public API format" }, "customFieldId": { "type": "string", "description": "Custom field id of this mirror" } } }, "ErrorType": { "type": "string", "enum": [ "invalid_request", "invalid_parameter", "parameter_required", "not_authorized", "access_forbidden", "not_allowed", "resource_not_found", "method_not_found", "too_many_requests", "rate_limit_exceeded", "server_error" ] }, "CustomFieldLinkToDatabaseField": { "required": [ "dataHubDatabaseId", "allowMultipleEntries" ], "type": "object", "properties": { "allowMultipleEntries": { "type": "boolean", "description": "Allow linkage of multiple records" }, "dataHubDatabaseId": { "type": "string", "description": "DataHub database identifier in DataHub Public API format" }, "mirrorFields": { "type": "array", "description": "Mirror fields associated with this link", "items": { "$ref": "#/components/schemas/CustomFieldLinkToDatabaseMirrorField" } } } }, "ErrorResponse": { "type": "object", "properties": { "errorDescription": { "type": "string" }, "error": { "$ref": "#/components/schemas/ErrorType" } } }, "CustomFieldSharingSpaceMembership": { "type": "string", "description": "* `Admin` - Grant access to space admins only\n* `Member` - Grant access to all space members", "enum": [ "Admin", "Member" ] }, "AccountId": { "pattern": "^([A-Z0-9]){8}$", "type": "string" }, "CustomFieldLinkToDatabaseFieldParam": { "required": [ "dataHubDatabaseId", "allowMultipleEntries" ], "type": "object", "properties": { "allowMultipleEntries": { "type": "boolean", "description": "Allow linkage of multiple records" }, "dataHubDatabaseId": { "type": "string", "description": "DataHub database identifier in DataHub Public API format" }, "mirrorFields": { "type": "array", "description": "Mirror fields associated with this link", "items": { "$ref": "#/components/schemas/CustomFieldLinkToDatabaseMirrorFieldParam" } } } }, "CustomFieldDropdownOption": { "required": [ "value" ], "type": "object", "properties": { "color": { "$ref": "#/components/schemas/DropdownOptionColor" }, "value": { "type": "string", "description": "value" } } }, "DropdownOptionColor": { "type": "string", "description": "* `Brown` - #795548\n* `DarkCyan` - #009688\n* `Gray` - #9E9E9E\n* `Blue` - #2196F3\n* `DarkBlue` - #3F51B5\n* `Orange` - #FF9800\n* `Red` - #E91E63\n* `YellowGreen` - #CDDC39\n* `Purple` - #9C27B0\n* `Yellow` - #FFEB3B\n* `Indigo` - #673AB7\n* `Turquoise` - #00BCD4\n* `DarkRed` - #F44336\n* `Green` - #8BC34A", "enum": [ "Brown", "DarkCyan", "Gray", "Blue", "DarkBlue", "Orange", "Red", "YellowGreen", "Purple", "Yellow", "Indigo", "Turquoise", "DarkRed", "Green" ] }, "Datapoint": { "required": [ "timesUsedTotal", "timesUsedThisMonth" ], "type": "object", "properties": { "lastUsedOn": { "type": "string", "description": "Last used on
Format: yyyy-MM-dd'T'HH:mm:ss'Z'" }, "timesUsedThisMonth": { "type": "number", "description": "Number of times used this month" }, "timesUsedTotal": { "type": "number", "description": "Total number of times used" }, "lastUsedBy": { "$ref": "#/components/schemas/UserId" } } }, "CustomFieldCurrency": { "type": "string", "description": "* `CHF`\n* `ARS`\n* `MXN`\n* `QAR`\n* `SAR`\n* `CLP`\n* `ZAR`\n* `INR`\n* `VND`\n* `THB`\n* `CNY`\n* `AUD`\n* `ILS`\n* `KRW`\n* `JPY`\n* `PLN`\n* `GBP`\n* `IDR`\n* `HUF`\n* `AMD`\n* `PHP`\n* `BYR`\n* `TRY`\n* `BWP`\n* `RUB`\n* `AED`\n* `HKD`\n* `TWD`\n* `EUR`\n* `COP`\n* `DKK`\n* `USD`\n* `CAD`\n* `MYR`\n* `NOK`\n* `RON`\n* `SGD`\n* `CZK`\n* `AZN`\n* `PEN`\n* `SEK`\n* `NZD`\n* `BRL`\n* `UAH`", "enum": [ "CHF", "ARS", "MXN", "QAR", "SAR", "CLP", "ZAR", "INR", "VND", "THB", "CNY", "AUD", "ILS", "KRW", "JPY", "PLN", "GBP", "IDR", "HUF", "AMD", "PHP", "BYR", "TRY", "BWP", "RUB", "AED", "HKD", "TWD", "EUR", "COP", "DKK", "USD", "CAD", "MYR", "NOK", "RON", "SGD", "CZK", "AZN", "PEN", "SEK", "NZD", "BRL", "UAH" ] }, "CustomFieldMirrorField": { "required": [ "dataHubFieldId", "linkToDatabaseCustomFieldId" ], "type": "object", "properties": { "dataHubFieldId": { "type": "string", "description": "DataHub field identifier in DataHub Public API format" }, "linkToDatabaseCustomFieldId": { "type": "string", "description": "Link to Database custom field id of this mirror" } } }, "CustomFieldType": { "type": "string", "description": "* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field", "enum": [ "Multiple", "Percentage", "Text", "Duration", "CalculatedNumeric", "Date", "CalculatedDate", "Numeric", "Contacts", "Checkbox", "Currency", "DropDown", "LinkToDatabase" ] }, "DataUsageStatistics": { "required": [ "spaceDataPoints" ], "type": "object", "properties": { "spaceDataPoints": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Datapoint" }, "description": "Map - Space data points" }, "accountDataPoints": { "$ref": "#/components/schemas/Datapoint" } } }, "SpaceId": { "pattern": "^([a-zA-Z0-9-_:\\.=]){1,256}$", "type": "string" }, "UserId": { "pattern": "^([A-Z0-9]){8}$", "type": "string" }, "CustomFieldSettingsParam": { "type": "object", "properties": { "allowOtherValues": { "type": "boolean", "description": "Allow users to input other values (only for DropDown type)", "default": "true" }, "optionColorsEnabled": { "type": "boolean", "description": "Is colors for options enabled (only for DropDown and MultipleSelect type). Use parameter 'options' to specify colors" }, "useThousandsSeparator": { "type": "boolean", "description": "Use thousands separator (only for Numeric type)", "default": "false" }, "linkToDatabaseInfo": { "$ref": "#/components/schemas/CustomFieldLinkToDatabaseFieldParam" }, "decimalPlaces": { "type": "number", "description": "Decimal places (only for Numeric, Percentage and Currency types)", "default": "2" }, "values": { "type": "array", "description": "Dropdown values without colors (only for DropDown and MultipleSelect type)", "items": { "type": "string" } }, "options": { "type": "array", "description": "Dropdown options with colors (only for DropDown and MultipleSelect type). Array of objects:\n{\"value\": \"string\", \"color\": \"enum: Brown, Red, Purple, Indigo, DarkBlue, Blue, Turquoise, DarkCyan, Green, YellowGreen, Yellow, Orange, Gray, DarkRed\"}\n", "items": { "$ref": "#/components/schemas/CustomFieldDropdownOption" } }, "currency": { "$ref": "#/components/schemas/CustomFieldCurrency" }, "aggregation": { "$ref": "#/components/schemas/CustomFieldAggregationType" }, "applicableEntityTypes": { "type": "array", "description": "Applicable entity types", "items": { "$ref": "#/components/schemas/CustomFieldApplicableEntityType" }, "default": "WorkItem" }, "contacts": { "type": "array", "description": "Allowed users or invitations (only for Users type)", "items": { "$ref": "#/components/schemas/UserId" } }, "inheritanceType": { "type": "string", "enum": [ "All", "Projects", "Folders" ] } } } }, "securitySchemes": { "HTTP": { "type": "http", "description": "Use OAuth 2.0 access token or permanent access token for authorization.", "scheme": "bearer", "bearerFormat": "JWT" } } } } ```