Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Role

Update an existing role's fields

Updates the role identified by roleId under the tenant specified by the required tenant-id header. Use this to change a role's name or description after creation; to create a new role use POST /roles. This is a full replacement, not a partial merge: any field omitted from the request body (name or description) is cleared on the role rather than left unchanged, so callers must resend the current value for any field they do not intend to change. Returns 200 with the full updated role object (RoleResponseDto). Returns 400 if the tenant-id header is absent or blank. Note: if the role does not exist, the current implementation returns 500 rather than 404 (tracked in CP-36405).

patch/roles/{roleId}

Path parameters

roleIdstring required

Headers

tenant-idstring

Request body

namestring required

Role name

descriptionstring

Role description

Example request

{
  "name": "Credentialing Reviewer",
  "description": "Read and comment access to credentialing workflows"
}

Response

Role updated successfully

idstring

Role ID

namestring

Role name

tenantIdstring

Tenant ID

descriptionstring

Role description

createdAtstring date-time
updatedAtstring date-time
createdBystring

ID of the user who created the role

updatedBystring

ID of the user who last updated the role

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Business Admin",
  "tenantId": "8f14e45f-ceea-467e-9906-ccfb98d21f95",
  "description": "Full access to all operations",
  "createdAt": "2022-03-10T12:15:50-04:00",
  "updatedAt": "2022-03-10T12:15:50-04:00",
  "createdBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11",
  "updatedBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11"
}