Update a task - Weeek Public API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Body Params application/json

title

string | null

optional

<= 255 characters

projectId

integer | null

optional

boardId

integer | null

optional

boardColumnId

integer | null

optional

priority

enum<integer> | enum<null>

optional

Allowed values:

0123

type

enum<string> | enum<null>

optional

Allowed values:

actionmeetcall

startDate

string <date> | null

optional

The start date of the task in Y-m-d format.
Cannot be provided with startDateTime or dueDateTime

dueDate

string <date> | null

optional

The due date of the task in Y-m-d format. Cannot be provided with startDateTime or dueDateTime

startDateTime

string <date-time> | null

optional

The start datetime of the task in ISO 8601 format. Cannot be provided with startDate or dueDate

dueDateTime

string <date-time> | null

optional

The due datetime of the task in ISO 8601 format. Cannot be provided with startDate or dueDate

tags

array[integer]

optional

Array of tag ids

customFields

object

optional

Key-value object with custom field id and custom field value for the task

For example

"customFields" : {
    "<text_custom_field_id>": "Text value",
    "<boolean_custom_field_id>": true,
    "<datetime_custom_field_id>": "<ISO 8601 datetime string>",
    "<select_custom_field_id>": "<custom_field_option_id>"
    "<multiselect_custom_field_id>": ["<custom_field_option_id>"],
    "<member_custom_field_id>": ["<user_id>"],
    "<contact_custom_field_id>": "<contact_id>",
    "<link_custom_field_id>": "Link value",
    "<approval_custom_field_id>": ["<user_id>"]
}

Example

{
  "title": "string",
  "projectId": 0,
  "boardId": 0,
  "boardColumnId": 0,
  "priority": 0,
  "type": "action",
  "startDate": "2019-08-24",
  "dueDate": "2019-08-24",
  "startDateTime": "2019-08-24T14:15:22Z",
  "dueDateTime": "2019-08-24T14:15:22Z",
  "tags": [
    0
  ],
  "customFields": {}
}

Responses

🟢200Successful response

application/json

Body

success

boolean

optional

task

object (Task)

required

integer

optional

parentId

integer | null

optional

title

string

optional

description

string | null

optional

duration

integer | null

optional

In minutes

overdue

integer

required

type

enum<string>

optional

Allowed values:

actionmeetcall

priority

integer | null

optional

0 - Low
1 - Medium
2 - High
3 - Hold

>= 0<= 3

isCompleted

boolean

optional

authorId

string

optional

ID of the user who created the task

userId

string | null

optional

ID of the user who is executing the task

boardId

integer | null

optional

boardColumnId

integer | null

optional

projectId

integer | null

optional

image

string | null

optional

isPrivate

boolean

optional

startDate

string <date> | null

optional

Start date of the task in Y-m-d format

startDateTime

string <date-time> | null

optional

Start date of the task in ISO 8601 format

dueDate

string <date> | null

optional

Due date of the task in Y-m-d format

dueDateTime

string <date-time> | null

optional

Due date of the task in ISO 8601 format

createdAt

string <date-time>

required

Date the task was created in ISO 8601 format

updatedAt

string <date-time>

required

Date the task was last updated in ISO 8601 format

tags

array[integer]

optional

subscribers

array[string]

optional

subTasks

array[integer]

optional

workloads

array [object {7}]

optional

timeEntries

array[object (Time entry) {6}]

required

customFields

array[object (CustomFieldValue) {6}]

optional

attachments

array[object (Attachment) {7}]

optional

Example

{
  "success": true,
  "task": {
    "id": 0,
    "parentId": 0,
    "title": "string",
    "description": "string",
    "duration": 0,
    "overdue": 0,
    "type": "action",
    "priority": 0,
    "isCompleted": true,
    "authorId": "string",
    "userId": "string",
    "boardId": 0,
    "boardColumnId": 0,
    "projectId": 0,
    "image": "string",
    "isPrivate": true,
    "startDate": "2019-08-24",
    "startDateTime": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24",
    "dueDateTime": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "tags": [
      0
    ],
    "subscribers": [
      "string"
    ],
    "subTasks": [
      0
    ],
    "workloads": [
      {
        "id": "string",
        "userId": "string",
        "type": 1,
        "date": "string",
        "duration": 0,
        "workStartAt": "string",
        "workEndAt": "string"
      }
    ],
    "timeEntries": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
        "type": 1,
        "isOvertime": true,
        "date": "2019-08-24",
        "duration": 2
      }
    ],
    "customFields": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "type": "text",
        "config": {
          "type": "switch"
        },
        "options": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "color": "blue"
          }
        ],
        "value": "string"
      }
    ],
    "attachments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
        "service": "weeek",
        "name": "string",
        "url": "http://example.com",
        "size": 0,
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
}