customFields

Sets the custom fields for a task.

Changed on

Sets the custom fields for a task. The required properties depend on the type of the custom field. <Check title="Required Permissions" icon="key">The user must have at least write permissions on the specified task.</Check>

post/tasks/{taskId}/setcustomfields

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasks/{taskId}/setcustomfields
  • Auth: HTTP bearer

Path parameters

taskIdstring uuid required

The id of the task to set custom fields for.

Request body

customFieldDefinitionIdstring uuid required

The custom field definition id.

userIdValuestring uuid nullable

The user id. The user id can be set for custom field type 'user'.

clientIdValuestring uuid nullable

The client id. The client id can be set for custom field type 'client'.

numberValuenumber double nullable

The number value. The number value can be set for custom field type 'number'.

selectionOptionIdValuestring uuid nullable

The selection option id value. The id can be set for custom field types 'select' and 'coloredSelect'.

textValuestring nullable

The text value. The text value can be set for custom field types 'text' and 'link'.

dateValuestring date-time nullable

The date value. The date value can be set for custom field types 'date' and 'datetime'.

booleanValueboolean nullable

The boolean value. The boolean value can be set for custom field type 'boolean'.

Response

No Content

object required

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostTaskSetCustomFieldsByTaskId removed and replaced with customFields_PostTaskSetCustomFieldsByTaskId