Update a task

Authorization

BearerAuth

AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

name*string

description?string

status?string

Default TODO.

priority?string

Default MEDIUM.

billable?boolean

JSON boolean (true / false). Defaults to true. Also accepts the legacy form strings "true" / "false".

estimatedHours?string

Accepts a number (e.g. 8 or 8.5) or a decimal-string ("8", "8.5"). Up to 4 decimal places; must be > 0.

assigneeIds?array<>

User UUIDs to assign. A Member token may only assign itself. Empty array = unassigned.

tags?array<>

Free-form tags; each ≤ 32 chars, capped at 20 (extras dropped server-side).

startDate?string

dueDate?string

endDate?string

Response Body

`application/json`

curl -X PATCH "https://example.com/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "name": "string"  }'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "name": "string",    "description": "string",    "status": "TODO",    "priority": "LOW",    "billable": true,    "estimatedHours": "string",    "assigneeIds": [      "80f8de4f-e685-4a1d-91fc-c0bb26d5cfc0"    ],    "tags": [      "string"    ],    "startDate": "2019-08-24",    "dueDate": "2019-08-24",    "endDate": "2019-08-24",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}

Was this page helpful?

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

402application/json

403application/json

404application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`