For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • 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
      • GETRetrieves all project templates.
      • POSTCreates a new project template.
      • GETRetrieves a specific project template.
      • PUTUpdates an existing project template.
      • DELDeletes a project template.
      • GETRetrieves all project statuses of a project template.
      • POSTAdds a project status to a project template.
      • GETRetrieves the task bundle associated with a project template.
      • GETReturns all task statuses of the project template with the specified id.
      • POSTCreates a new task status for the specified project template.
      • GETReturns the task status of the project template with the specified id.
      • PUTUpdates a task status for the specified project template.
      • DELDeletes the task status of the project template with the specified id.
      • POSTUpdates the order of a project status within a project template.
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceProject Templates

Updates an existing project template.

PUT
https://api.awork.com/api/v1/projecttemplates/:projectTemplateId
PUT
/api/v1/projecttemplates/:projectTemplateId
$curl -X PUT https://api.awork.com/api/v1/projecttemplates/projectTemplateId \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3 "name": "Website Redesign Template",
4 "description": "A comprehensive template for website redesign projects including all phases from planning to launch.",
5 "createdOn": "2024-04-10T08:45:00Z",
6 "createdBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
7 "updatedOn": "2024-05-01T12:00:00Z",
8 "updatedBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
9 "isBillableByDefault": "auto",
10 "defaultTaskListIdForEmails": "b2c3d4e5-f6a7-8901-bcde-234567890abc",
11 "hasImage": true,
12 "copyImageToProjectOnCreation": true,
13 "projectTypeId": "f6a7b8c9-0123-4567-cdef-67890abcdef1",
14 "workflowId": "a7b8c9d0-1234-5678-cdef-7890abcdef12",
15 "timeBudget": 72000,
16 "hasRelativeTasks": true,
17 "projectStatuses": [
18 {
19 "id": "c3d4e5f6-a7b8-9012-cdef-34567890abcd",
20 "name": "In Progress",
21 "type": "progress",
22 "order": 2,
23 "createdOn": "2024-04-10T08:45:00Z",
24 "createdBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
25 "updatedOn": "2024-05-01T12:00:00Z",
26 "projectTemplateId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
27 "projectId": "d4e5f6a7-b890-1234-cdef-4567890abcde",
28 "workflowId": "e5f6a7b8-9012-3456-cdef-567890abcdef",
29 "updatedBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
30 "isExternal": false
31 }
32 ]
33}
<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>
Was this page helpful?
Previous

Deletes a project template.

Next
Built with
Required Permissions
The user must be an admin or have project-manage-config:write permissions.

Authentication

AuthorizationBearer

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

Path parameters

projectTemplateIdstringRequiredformat: "uuid"
The id of the project template.

Request

The model to update the project template.
namestring or nullOptional0-255 characters
Name of the project template.
descriptionstring or nullOptional0-25000 characters
Description of the project template.
isBillableByDefaultstring or nullOptional

Whether the project should be billable by default. Can be ‘on’, ‘off’, or ‘auto’. Default is auto.

defaultTaskListIdForEmailsstring or nullOptionalformat: "uuid"
copyImageToProjectOnCreationbooleanOptional
Whether the template image should be copied to the project during project creation. If the template has no image, no image is copied. No image is copied from the client.
projectTypeIdstring or nullOptionalformat: "uuid"
Project type id of the project template.
timeBudgetinteger or nullOptional
The amount of time budgeted for the project in seconds. If null, the time budget will be unchanged. Set to 0 to remove the time budget.

Response

OK
idstringformat: "uuid"
The id of the template.
namestring or null
The name of the template.
descriptionstring or null
The description that will be used for the project created from this template. It will be appended to the project description provided by the user.
createdOnstringformat: "date-time"
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOnstringformat: "date-time"
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.
isBillableByDefaultstring or null
Whether project times should be billable by default, if the project was created by this template. Can be 'on', 'off', or 'auto'.
defaultTaskListIdForEmailsstring or nullformat: "uuid"
The id references the task list, which is used to assign tasks created by email to.
hasImageboolean
Whether the project template has an image in the files service.
copyImageToProjectOnCreationboolean
Whether the template image should be copied to the project during project creation. If the template has no image, no image is copied. No image is copied from the client.
projectTypeIdstring or nullformat: "uuid"
The id of the project type.
workflowIdstring or nullformat: "uuid"
The id of the workflow linked to this template.
timeBudgetinteger
The amount of time budgeted for the project in seconds.
hasRelativeTasksboolean
True if any of the tasks of the template has relative dates.
projectStatuseslist of objects or nullDeprecated

Deprecated. Use GET /projectTemplates/{projectTemplateId}/projectStatuses instead. The list of project statuses associated with the template. This can be either workflow statuses or template-specific statuses depending on whether the template is linked to a workflow or not.

Errors

400
Bad Request Error
404
Not Found Error