Updates an existing project role. | awork API

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

{
  "name": "Senior Project Manager",
  "isDefault": false,
  "defaultProjectRoleId": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "allowOnlyProjectMasterDataRead": false,
  "id": "4a3b2c1d-0e9f-8a7b-6c5d-4e3f2a1b0c9d",
  "memberCount": 12,
  "members": [
    {
      "id": "7e6d5c4b-3a2f-1e0d-9c8b-7a6f5e4d3c2b",
      "userId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "firstName": "Emily",
      "lastName": "Johnson",
      "hasImage": true,
      "projectRoleId": "4a3b2c1d-0e9f-8a7b-6c5d-4e3f2a1b0c9d",
      "projectRoleName": "Senior Project Manager",
      "isResponsible": true,
      "isDeactivated": false,
      "isExternal": false
    }
  ],
  "createdOn": "2023-11-20T08:45:00Z",
  "createdBy": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
  "updatedOn": "2024-04-10T14:20:00Z",
  "updatedBy": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
}

Required Permissions

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

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

Authentication

AuthorizationBearer

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

Path parameters

projectRoleIdstringRequiredformat: "uuid"

The id of the project role.

Request

The model to update the project role.

namestringRequired0-255 characters

The name of the project role. Required.

isDefaultboolean or nullOptional

Whether to use this role as default when adding new project members.

defaultProjectRoleIdstring or nullOptionalformat: "uuid"

The id of the new default project role. Required if the updated project role is the current default role.

allowOnlyProjectMasterDataReadbooleanOptional

Whether this role is allowed to have only read permissions for project-master-data.

Response

namestring0-255 characters

The name of the project role. Required.

isDefaultboolean or null

Whether to use this role as default when adding new project members.

defaultProjectRoleIdstring or nullformat: "uuid"

The id of the new default project role. Required if the updated project role is the current default role.

allowOnlyProjectMasterDataReadboolean

Whether this role is allowed to have only read permissions for project-master-data.

idstringformat: "uuid"

The id of the project role.

memberCountinteger

The count of members which are linked to this role.

memberslist of objects or null

The members which are linked to this role.

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.

Errors

400

Bad Request Error

404

Not Found Error