v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB

Custom Fields

Create Custom Field (Account)

Create custom field in specified account.

<b>Scopes:</b> Default, wsReadWrite

post/customfields

Query parameters

titlestring required

Custom field title

Custom field title

type'Multiple' | 'Percentage' | 'Text' | 'Duration' | 'CalculatedNumeric' | 'Date' | 'CalculatedDate' | 'Numeric' | 'Contacts' | 'Checkbox' | 'Currency' | 'DropDown' | 'LinkToDatabase' required

Multiple - Collection field
Percentage - Comparable field
Text - String field, Comparable field
Duration - Comparable field
CalculatedNumeric - Calculated comparable field
Date - Comparable field
CalculatedDate - Calculated comparable field
Numeric - Comparable field
Contacts - Collection field
Checkbox - Boolean field
Currency - Comparable field
DropDown - String field, Comparable field
LinkToDatabase - Link to database field

Custom field type

Multiple - Collection field
Percentage - Comparable field
Text - String field, Comparable field
Duration - Comparable field
CalculatedNumeric - Calculated comparable field
Date - Comparable field
CalculatedDate - Calculated comparable field
Numeric - Comparable field
Contacts - Collection field
Checkbox - Boolean field
Currency - Comparable field
DropDown - String field, Comparable field
LinkToDatabase - Link to database field

spaceIdstring

Custom field space ID

Custom field access settings

Users to share custom field with. Parameter is obsolete, use 'sharing' instead

Custom field settings

descriptionstring

Custom field description

Custom field description

Response

success response

kind'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' | 'userAggregatedCapacity' | 'cascadingFieldSettings'