Updates an existing project template with new values and configuration. | awork API

import requests
url = "https://api.awork.com/api/v1/projecttemplates/projectTemplateId"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Website Redesign Template",
  "description": "A comprehensive template for website redesign projects including all necessary phases and tasks.",
  "createdOn": "2024-04-10T08:45:00Z",
  "createdBy": "f1e2d3c4-b5a6-7890-cd12-ef34ab567890",
  "updatedOn": "2024-05-01T14:20:00Z",
  "updatedBy": "f1e2d3c4-b5a6-7890-cd12-ef34ab567890",
  "isBillableByDefault": "auto",
  "defaultTaskListIdForEmails": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
  "projectStatuses": [
    {
      "id": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
      "name": "In Progress",
      "type": "progress",
      "order": 2,
      "createdOn": "2024-04-10T08:45:00Z",
      "createdBy": "f1e2d3c4-b5a6-7890-cd12-ef34ab567890",
      "updatedOn": "2024-05-01T14:20:00Z",
      "projectTemplateId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "projectId": "d4e5f6a7-b890-1234-cd56-ef78ab901234",
      "workflowId": "e5f6a7b8-9012-3456-cd78-ef90ab123456",
      "updatedBy": "f1e2d3c4-b5a6-7890-cd12-ef34ab567890",
      "isExternal": false
    }
  ],
  "hasImage": true,
  "copyImageToProjectOnCreation": true,
  "projectTypeId": "f6a7b890-1234-5678-cd90-ef12ab345678",
  "workflowId": "a7b89012-3456-7890-cd12-ef34ab567890",
  "timeBudget": 864000,
  "hasRelativeTasks": true
}

Required Permissions

The user must be an admin or have project-manage-config:write permissions.

<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

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

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.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

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.

projectStatuseslist of objects or null

The project statuses of the template.

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.

Errors

400

Bad Request Error

404

Not Found Error