WRwrike
Custom Fields

Modify Custom Field

Changed on

Modify custom field.

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

put/customfields/{customfieldId}

Request

  • Base URL
    https://www.wrike.com/api/v4
  • URL
    https://www.wrike.com/api/v4/customfields/{customfieldId}
  • Auth
    HTTP bearer

Path parameters

customfieldIdstring required

Query parameters

titlestring

Custom field title

type'Multiple' | 'Percentage' | 'Text' | 'Duration' | 'CalculatedNumeric' | 'Date' | 'CalculatedDate' | 'Numeric' | 'Contacts' | 'Checkbox' | 'Currency' | 'DropDown' | 'LinkToDatabase'
  • 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. Conversion from any type of field to LinkToDatabase is not supported

  • 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
changeScope'Space' | 'Account'
  • Space - Use it with valid 'spaceId' parameter to move custom field to space level
  • Account - Use it with null 'spaceId' parameter to move custom field to account level

Custom field scope

  • Space - Use it with valid 'spaceId' parameter to move custom field to space level
  • Account - Use it with null 'spaceId' parameter to move custom field to account level
spaceIdstring

Custom field space ID

Custom field access settings

Share custom field with specified users. Parameter is obsolete, use 'sharing' instead

Unshare custom field from specified users. Parameter is obsolete, use 'sharing' instead

Custom field type settings

Add mirror fields to LinkToDatabase field

Remove mirror fields from to LinkToDatabase field

descriptionstring

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' | 'blueprintSearch' | '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' | 'mcpFeatures' | 'attachmentUploadUrl' | 'userAggregatedCapacity' | 'cascadingFieldSettings' | 'recommendResources' | 'aggregatedAllocatedEffort' | 'aggregatedTotalUserEffort' | 'aggregatedTimeSpent' | 'folderBlueprint' | 'taskBlueprint'

Changes

  • 7b0a63c547ddRevision changes
    • warning

      added the new aggregatedAllocatedEffort enum value to the response property for the response status

    • warning

      added the new aggregatedTimeSpent enum value to the response property for the response status

    • warning

      added the new aggregatedTotalUserEffort enum value to the response property for the response status

    • warning

      added the new attachmentUploadUrl enum value to the response property for the response status

    • warning

      added the new blueprintSearch enum value to the response property for the response status

    • warning

      added the new folderBlueprint enum value to the response property for the response status

    • warning

      added the new mcpFeatures enum value to the response property for the response status

    • warning

      added the new recommendResources enum value to the response property for the response status

    • warning

      added the new taskBlueprint enum value to the response property for the response status

    • info

      added the optional property // to the response with the status