Search...
/
Support
Developer Forum
Login
Overview
Introduction
Getting Started
Authentication
Error Handling
Pagination
Filtering
Ordering
Rate Limits
Permissions
Webhooks
Changelog
Support
API Reference
Projects Overview
Projects
Project Types
Project Statuses
Project Roles
Project Comments
Project Tags
Project Milestones
Project Automations
Project Actions
Project Time Bookings
Autopilot
Tasks Overview
Tasks
Task Lists
Task Views
Project Tasks
Private Tasks
Assigned Tasks
Checklist Items
Task Comments
Task Tags
Task Dependencies
Task Schedules
Tasks Batch
Type of Work
Time Tracking Overview
Time Entries
Time Tracking
Time Reports
Project Time Entries
Task Time Entries
Companies Overview
Companies
Company Tags
Users Overview
Users
User Capacity
User Tags
Absences
Dashboards
Files & Images Overview
Files
Project Files
Task Files
Company Files
Comment Files
User Files
Workspace Files
Project Template Files
Task Template Files
Shared Files
Temporary Files
Images
Custom Fields Overview
Custom Fields
GET
Returns all custom field definitions.
POST
Creates a new custom field definition.
PUT
Updates a custom field selection option for an existing custom field definition.
DEL
Deletes a custom field selection option for an existing custom field definition.
PUT
Updates an existing custom field definition with the specified id.
DEL
Deletes the custom field definition with the specified id.
POST
Sets the custom fields for a task template.
POST
Unlinks a custom field definition from a projectTemplate.
PUT
Updates the order of a custom field definition for a project template.
POST
Links a custom field definition to a project.
POST
Links a custom field definition to a project template.
POST
Creates a custom field selection option for an existing custom field definition.
POST
Unlinks a custom field definition from a project.
GET
Returns all custom field definitions for a project template.
POST
Sets the custom fields for a task.
GET
Returns all custom field definitions for a project.
PUT
Updates the order of a custom field definition for a project.
Workload & Planning Overview
Workload
Project Templates Overview
Project Templates
Task Bundles
Task Templates
Task Dependency Templates
Project Template Tags
Project Milestone Templates
Project Template Automations
Project Template Actions
Login & Access Overview
Accounts
Invitations
Permissions
Roles
Teams
Workspaces
API Management Overview
API Users
Webhooks
Client Applications
Support
Developer Forum
Login
API Reference
Custom Fields
Sets the custom fields for a task.
POST
https://
api.awork.com
/
api
/
v1
/
tasks
/
:taskId
/
setcustomfields
The required properties depend on the type of the custom field.
Required Permissions:
Any authenticated user.
Path parameters
taskId
string
Required
The id of the task to set the custom fields for.
Request
This endpoint expects a list of objects.
customFieldDefinitionId
string
Required
The custom field definition id.
userIdValue
string
Optional
The user id. The user id can be set for custom field type 'user'.
numberValue
double
Optional
The number value. The number value can be set for custom field type 'number'.
selectionOptionIdValue
string
Optional
The selection option id value. The id can be set for custom field types 'select' and 'coloredSelect'.
textValue
string
Optional
The text value. The text value can be set for custom field types 'text' and 'link'.
dateValue
datetime
Optional
The date value. The date value can be set for custom field types 'date' and 'datetime'.
booleanValue
boolean
Optional
The boolean value. The boolean value can be set for custom field type 'boolean'.
Errors
404
Not Found
Built with