absenceRegions11

absences5

accounts2

agentFiles2

agentRuntime10

agentSchedules10

agentSkills20

agentThreadFiles2

agentThreads7

apiUsers5

assignedTasks8

autopilot6

checklistItems16

clientApplications11

companies11

companyFiles16

companyTags6

customAgents16

customFields23

dashboards1

documentComments8

documentFiles15

documents23

documentSpaces11

files2

fileUpload2

filters20

images24

invitations3

permissions3

privateTasks10

projectActivities1

projectAutomations13

projectComments7

projectFiles18

projectMembers2

projectMilestones6

projectMilestoneTemplates5

projectRoles8

projects13

projectStatuses7

projectTags6

projectTasks6

projectTemplateAutomations12

projectTemplateFiles17

projectTemplates14

projectTemplateTags6

projectTypes7

retainers5

roles17

search1

sharedFiles2

taskActivities1

taskBundles29

taskComments7

taskDependencies4

taskDependencyTemplates5

taskFiles17

taskLists13

tasks21

taskSchedules6

taskStatuses5

taskTags9

taskTemplateFiles17

taskTemplates7

taskTemplateTags6

teams9

temporaryFiles6

timeBookings10

timeEntries18

timeReports1

timeTracking8

timeTrackingSettings1

typeOfWork7

userCapacities2

userFiles17

users15

userTags6

webhooks8

workflowAutomations12

workflows21

workload1

workspaceAbsences4

workspaceFiles17

workspaces3

projects

Updates the specified project's key.

Changed on Sep 17, 2026

Updates the project key and the identifiers of tasks in that project. The key must be unique in the workspace and use uppercase letters, numbers, or dashes.

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

post/projects/{projectId}/setprojectkey

Request

Base URL: https://api.awork.com/api/v1
URL: https://api.awork.com/api/v1/projects/{projectId}/setprojectkey
Auth: HTTP bearer

Path parameters

projectIdstring uuid required

The id of the project.

Request body

projectKeystring required

The new project key. Must be uppercase letters (A-Z), numbers (0-9), and dashes (-), between 1-32 characters.

Response

namestring required

The name of the Project. Max allowed length: 1000 characters.

isPrivateboolean

Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.

descriptionstring nullable

The project description. Max allowed length: 25000 characters.

startDatestring date-time nullable

The start date of the project.

dueDatestring date-time nullable

The due date of the project.

companyIdstring uuid nullable

The id of the company.

timeBudgetinteger nullable

The time budget the project has, in seconds.

isBillableByDefaultboolean nullable

Whether project times should be billable by default.

projectTypeIdstring uuid nullable

The id of the project type of this project.

colorstring nullable

The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.

deductNonBillableHoursboolean

Whether to deduct non-billable hours from project budgets.

isProjectKeyVisibleboolean nullable

Whether project key should be visible for this project. If null, it will use the workspace default setting.

projectStatusIdstring uuid

The id of the project status.

projectTemplateIdstring uuid nullable

The id of the template which is used to create the project.

publicProjectTemplateIdstring uuid nullable

The id of the public template which is used to create the project.

workflowIdstring uuid nullable

The id of the workflow to link to the project. Cannot be specified if ProjectTemplateId is set.

idstring uuid

Id of the project.

projectKeystring nullable

The unique project key within the workspace (e.g., "NIKE"). Maximum 32 characters, uppercase letters, numbers, and dashes only.

hasImageboolean

Whether the project has an image.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

closedOnstring date-time nullable

The date the project was set to closed.

closedBystring uuid nullable

The user who closed the project.

createdByProjectTemplateIdstring uuid nullable

The id of the template the project was created from.

plannedDurationinteger nullable

The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.

totalPlannedDurationWithHierarchyinteger nullable

The total planned duration of the project with hierarchy, in seconds. Calculated based on the planned durations of tasks and task lists of the project. Sum of Sum(TotalPlannedDurationWithHierarchy of all task lists) and Sum(TotalPlannedDurationWithHierarchy of all parent tasks without list)

tasksCountinteger nullable

The number of all tasks related to the project.

tasksDoneCountinteger nullable

The number of all tasks in status 'done' related to the project.

trackedDurationinteger nullable

The summed up duration of all time trackings for this project.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

isExternalboolean

True if this entity is coming from an external workspace (awork Connect).

isRetainerboolean

Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.

isMultiAssignmentAllowedboolean

Indicates whether multi-assignment is allowed for tasks in this project's workspace.

Changes

Sep 17, 20261556e0487867 Revision changes
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security oauth2 was added to the API
Sep 12, 20268e46cf415581 Revision changes
- info
  api operation id PostProjectSetProjectKeyByProjectId removed and replaced with projects_PostProjectSetProjectKeyByProjectId

Operation history (3 revisions)