Skip to content
TeamGrid Developer

Update a task

PATCH
/tasks/{id}
curl --request PATCH \
  --url https://api.de.teamgrid.app/v1/tasks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "assigneeId": "example", "billable": true, "completed": true, "description": "example", "dueAt": "2026-04-15T12:00:00Z", "groupId": "example", "listId": "example", "name": "example", "plannedEndAt": "2026-04-15T12:00:00Z", "plannedMinutes": 1, "plannedStartAt": "2026-04-15T12:00:00Z", "projectId": "example", "serviceId": "example", "subscriberIds": [ "example" ], "tagIds": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
>= 1 properties
assigneeId
string | null
<= 128 characters
billable
boolean | null
completed
boolean | null
description
string | null
<= 50000 characters
dueAt
string | null format: date-time
groupId
string | null
<= 128 characters
listId
string | null
<= 128 characters
name
string | null
>= 1 characters <= 500 characters
plannedEndAt
string | null format: date-time
plannedMinutes
integer | null
plannedStartAt
string | null format: date-time
projectId
string | null
<= 128 characters
serviceId
string | null
<= 128 characters
subscriberIds
Array<string> | null
<= 500 items
tagIds
Array<string> | null
<= 500 items
not matching
assigneeId
required
string
groupId
required
string
Examplegenerated
{
  "assigneeId": "example",
  "billable": true,
  "completed": true,
  "description": "example",
  "dueAt": "2026-04-15T12:00:00Z",
  "groupId": "example",
  "listId": "example",
  "name": "example",
  "plannedEndAt": "2026-04-15T12:00:00Z",
  "plannedMinutes": 1,
  "plannedStartAt": "2026-04-15T12:00:00Z",
  "projectId": "example",
  "serviceId": "example",
  "subscriberIds": [
    "example"
  ],
  "tagIds": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated resource.

Media typeapplication/json
object
data
required
object
attributes
required
object
archived
required
boolean
assigneeId
required
string | null
billable
required
boolean | null
completed
required
boolean
createdAt
required
string | null format: date-time
description
required
string
dueAt
required
string | null format: date-time
groupId
required
string | null
listId
required
string | null
name
required
string
plannedEndAt
required
string | null format: date-time
plannedMinutes
required
number | null
plannedStartAt
required
string | null format: date-time
projectId
required
string | null
serviceId
required
string | null
subscriberIds
required
Array<string>
tagIds
required
Array<string>
updatedAt
required
string | null format: date-time
id
required
string
type
required
Allowed value: task
meta
required
object
requestId
required
string
Example
{
  "data": {
    "type": "task"
  }
}

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

404

Section titled “404”

The tenant-scoped resource does not exist.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}