SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceTask Views

Updates an existing task view.

PUT
https://api.awork.com/api/v1/me/taskviews/:taskViewId
PUT
/api/v1/me/taskviews/:taskViewId
1curl -X PUT https://api.awork.com/api/v1/me/taskviews/taskViewId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it
200Updated
1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "isShared": true,
4  "filter": "(project/company ne null)",
5  "filterSettings": "(json data representing the filter settings. Too long to show in doc)",
6  "name": "Projects with defined company",
7  "createdOn": "2022-03-10T16:03:49.100Z",
8  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
9  "updatedOn": "2022-03-15T16:55:00.100Z",
10  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
11}
Updates an existing task view. If the provided filter string is invalid the request will fail with status 400. Only the original author can update a non-shared task view. Shared task views can only be updated by the original author or someone with project planning permissions. <Check title="Required Permissions">Any authenticated user.</Check>
Was this page helpful?
Previous

Deletes an existing task view that is specified by an id.

Next
Built with
Deletes an existing task view that is specified by an id.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

taskViewIdstringRequiredformat: "uuid"
The id of the task view that will be updated.

Request

The model to update the task view.
filterstring or nullOptional
The filter query that is applied to the tasks results. The syntax follows the normal filter conventions that can be used on GET routes.
filterSettingsstring or nullOptional
The filter settings to display.
namestring or nullOptional
The name of the task view.
isSharedbooleanOptional
If the taskview is shared or not.

Response

OK
idstring or nullformat: "uuid"
The id of the task view.
isSharedboolean or null
Whether this task view is shared within the workspace.
filterstring or null
The filter query that is applied to the tasks results. The syntax follows the normal filter coventions that can be used on GET routes.
filterSettingsstring or null
The filter settings to display.
namestring or null
The name of the task view.
createdOnstring or nullformat: "date-time"
The date this task view was created.
createdBystring or nullformat: "uuid"
The id of the user who created this task view.
updatedOnstring or nullformat: "date-time"
The date this task view was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this task view.
The name of the task view.
The date this task view was created.
The id of the user who created this task view.
The date this task view was last modified.
The id of the user who last modified this task view.
The id of the task view that will be updated.
OK

Bearer authentication of the form Bearer <token>, where token is your auth token.

Updates an existing task view. If the provided filter string is invalid the request will fail with status 400. Only the original author can update a non-shared task view. Shared task views can only be updated by the original author or someone with project planning permissions.

Required Permissions
Any authenticated user.