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.
SupportContact salesStart free trial
  • Getting started
    • Overview
    • Authentication
    • Querying tutorial
    • OData Integrations
    • Work Breakdown Structure
    • Software Development Kits
    • API Patch Notes
    • FAQ
    • Terms of use
  • API Reference
      • GETList Business Roles
      • POSTCreate Business Role
      • PUTUpdate Business Role
      • DELDelete Business Role
      • GETResend Email Validation
LogoLogo
SupportContact salesStart free trial
API ReferenceSecurity

Update Business Role

PUT
https://api.projectmanager.com/api/data/security/businessroles/:roleId
PUT
/api/data/security/businessroles/:roleId
$curl -X PUT https://api.projectmanager.com/api/data/security/businessroles/roleId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {}
>]'
200Updated
1{
2  "error": {
3    "technicalError": "string",
4    "additionalErrors": [
5      "string"
6    ],
7    "validationErrors": {},
8    "message": "string"
9  },
10  "success": true,
11  "hasError": true,
12  "statusCode": "Continue",
13  "data": {
14    "id": "string",
15    "name": "string",
16    "description": "string",
17    "isGlobalAdmin": true,
18    "isAdmin": true,
19    "isCustom": true,
20    "isDefault": true,
21    "isGuest": true,
22    "permissions": {}
23  }
24}
Send property change sets using the same pattern as other workspace batch-update APIs. For permissions, include a permissions property with a partial or full permissions object; omitted keys are merged with the current role. Keys may use the same names as GET `permissions` (e.g. `editUsers`) or RetrieveMe / POST-create style (e.g. `editUser`). The response body matches create when successful.
Was this page helpful?
Previous

Delete Business Role

Next
Built with

Send property change sets using the same pattern as other workspace batch-update APIs.

For permissions, include a permissions property with a partial or full permissions object; omitted keys are merged with the current role. Keys may use the same names as GET permissions (e.g. editUsers) or RetrieveMe / POST-create style (e.g. editUser). The response body matches create when successful.

Authentication

AuthorizationBearer

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

Path parameters

roleIdstringRequiredformat: "uuid"
Business role identifier.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

List of property name and value pairs to apply.
propertystringOptional

Field to change: name, description, or permissions.

valueany or nullOptional

New value for the field; for permissions, a JSON object in the role permissions matrix shape.

idstring or nullOptionalformat: "uuid"
Optional identifier when the change targets a nested or keyed item.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject

Workspace business role returned by the data API security endpoints (list/update responses and create response).