Create task - Weeek Public API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

title

string

optional

description

string | null

optional

day

string | null

optional

projectId

integer | null

optional

parentId

integer | null

optional

userId

string | null

optional

type

enum<string>

optional

Allowed values:

actionmeetcall

priority

enum<integer> | enum<null>

optional

Allowed values:

0123

boardId

integer | null

optional

boardColumnId

integer | null

optional

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",
  "description": "string",
  "day": "string",
  "projectId": 0,
  "parentId": 0,
  "userId": "string",
  "type": "action",
  "priority": 0,
  "boardId": 0,
  "boardColumnId": 0,
  "customFields": {}
}

Responses

🟢200Successful response

application/json

Body

success

boolean

optional

task

object (Task)

optional

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": 19,
    "parentId": null,
    "title": "4",
    "description": "",
    "date": "19.03.2022",
    "time": "23:00",
    "duration": 60,
    "type": "action",
    "priority": null,
    "isCompleted": false,
    "authorId": "3e265f8a-5c6c-4169-a2b1-6182f10b712b",
    "userId": null,
    "boardId": null,
    "boardColumnId": null,
    "projectId": null,
    "image": null,
    "isPrivate": false,
    "dateStart": null,
    "dateEnd": null,
    "timeStart": null,
    "timeEnd": null,
    "tags": [],
    "subscribers": [
      "3e265f8a-5c6c-4169-a2b1-6182f10b712b"
    ],
    "workloads": [
      {
        "id": "bc92d5f2-3aaf-49cc-8010-5007ced66ea6",
        "userId": "24d20bfa-bc7e-471e-8c17-a199734532dc",
        "type": 2,
        "date": "05.10.2022",
        "duration": 60,
        "workStartAt": null,
        "workEndAt": null
      }
    ]
  }
}