> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ruddr.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a client role

> Linked client roles (where `workspaceRole` is not `null`) cannot be modified and will return a 409 ReadOnlyError. Delete and recreate to change linking.

A role defining billing terms for work performed for a specific client. Client roles can be created independently or linked to a workspace role, which overrides the role's name, billing, and classification fields.


## OpenAPI

````yaml openapi.json PATCH /client-roles/{id}
openapi: 3.1.0
info:
  title: Ruddr API
  version: '1.0'
  license:
    name: Proprietary
    url: https://www.ruddr.com/master-subscription-agreement
servers:
  - url: https://www.ruddr.io/api/workspace
security:
  - bearerAuth: []
tags:
  - name: Allocations
    description: Manage resource allocations for scheduling team members to projects.
  - name: Availability Periods
    description: Manage member availability periods for capacity planning.
  - name: Business Units
    description: >-
      Manage business units for organizing invoice settings and grouping clients
      and projects.
  - name: Client Roles
    description: Manage client roles and their billing terms.
  - name: Client Tags
    description: Manage tags for categorizing clients.
  - name: Clients
    description: Manage clients and their billing settings.
  - name: Companies
    description: Manage companies in the CRM pipeline.
  - name: Company Spend Tiers
    description: Manage spend tier classifications for companies.
  - name: Company Types
    description: Manage type classifications for companies.
  - name: Contact Tags
    description: Manage tags for categorizing contacts.
  - name: Contacts
    description: Manage contacts associated with clients, companies, and opportunities.
  - name: Cost Periods
    description: Manage member cost rate periods for profitability tracking.
  - name: Credit Notes
    description: View credit notes issued against invoices.
  - name: Disciplines
    description: Manage disciplines for classifying member skill areas.
  - name: Exchange Rate
    description: Get exchange rates for multi-currency workspaces.
  - name: Exchange Rate Periods
    description: Manage custom exchange rate periods for currency conversion.
  - name: Expense Categories
    description: Manage expense categories for tracking and reporting.
  - name: Expense Items
    description: Manage individual expense line items.
  - name: Expense Reports
    description: Manage expense reports submitted by members.
  - name: Holiday Schedules
    description: Manage holiday schedules for capacity and availability planning.
  - name: Holidays
    description: Manage individual holidays within holiday schedules.
  - name: Industries
    description: Manage industry classifications for clients and companies.
  - name: Invoice Items
    description: Manage invoice line item types for billing.
  - name: Invoices
    description: View invoices and their line items.
  - name: Job Titles
    description: Manage job title classifications for members.
  - name: Locations
    description: Manage office locations for members and projects.
  - name: Member Certifications
    description: Manage certification types that can be assigned to members.
  - name: Member Levels
    description: Manage member level classifications for career tracking.
  - name: Member Tags
    description: Manage tags for categorizing members.
  - name: Members
    description: Manage workspace members and their profiles.
  - name: Opportunities
    description: Manage sales opportunities in the CRM pipeline.
  - name: Opportunity Pipelines
    description: Manage pipelines for tracking opportunity stages.
  - name: Opportunity Lead Sources
    description: Manage lead source classifications for opportunities.
  - name: Opportunity Stages
    description: Manage pipeline stage definitions for opportunities.
  - name: Opportunity Tags
    description: Manage tags for categorizing opportunities.
  - name: Opportunity Types
    description: Manage type classifications for opportunities.
  - name: Payment Methods
    description: Manage payment method options for invoices.
  - name: Payments
    description: View payments received against invoices.
  - name: Pipeline Activities
    description: >-
      Manage pipeline activities associated with companies, contacts, members,
      and opportunities.
  - name: Pipeline Activity Types
    description: Manage activity type classifications for pipeline activities.
  - name: Practices
    description: Manage practice area classifications for organizing projects and members.
  - name: Project Budget Expenses
    description: Manage expense budget line items on projects.
  - name: Project Budget Other Items
    description: Manage other budget line items on projects.
  - name: Project Budget Product Items
    description: Manage product budget line items on projects.
  - name: Project Budget Service Items
    description: Manage additional service budget line items on projects.
  - name: Project Expenses
    description: Manage project-level expense line items.
  - name: Project Groups
    description: View project groups for organizing related projects.
  - name: Project Health Reports
    description: Manage project health status reports.
  - name: Project Invoice Milestones
    description: Manage invoice milestones for fixed-fee project billing.
  - name: Project Members
    description: Manage team member assignments on projects.
  - name: Project Monthly Budget Expenses
    description: Manage monthly expense budget line items on projects.
  - name: Project Monthly Budget Other Items
    description: Manage monthly other budget line items on projects.
  - name: Project Monthly Budget Product Items
    description: Manage monthly product budget line items on projects.
  - name: Project Monthly Budget Service Items
    description: Manage monthly additional service budget line items on projects.
  - name: Project Other Items
    description: Manage project-level other item line items.
  - name: Project Product Items
    description: Manage project-level product line items.
  - name: Project Revenue Adjustments
    description: Manage earned revenue adjustments for projects.
  - name: Project Revenue Recognition Entries
    description: Manage revenue recognition entries for projects.
  - name: Project Roles
    description: Manage roles defined on projects for billing and staffing.
  - name: Project Service Items
    description: Manage project-level additional service line items.
  - name: Project Tags
    description: Manage tags for categorizing projects.
  - name: Project Tasks
    description: Manage tasks on projects for time tracking and planning.
  - name: Project Types
    description: Manage type classifications for projects.
  - name: Projects
    description: Manage projects and their settings.
  - name: Resource Placeholders
    description: Manage placeholder resources for allocation planning.
  - name: Security Roles
    description: View security roles for assigning member permissions.
  - name: Skills
    description: Manage skill classifications for members and resource planning.
  - name: Task Categories
    description: Manage task category classifications for project tasks.
  - name: Task Tags
    description: Manage tags for categorizing project tasks.
  - name: Task Templates
    description: Manage reusable task templates for projects.
  - name: Tax Rates
    description: Manage tax rates for invoicing.
  - name: Time Entries
    description: Manage time entries for tracking hours on projects.
  - name: Time Off Types
    description: Manage time off type classifications.
  - name: Timesheet Attestations
    description: Manage attestation statements members sign when submitting timesheets.
  - name: Timesheets
    description: Manage timesheet submissions for tracking hours across a period.
  - name: Utilization Target Periods
    description: Manage member utilization target periods for capacity planning.
  - name: Workspace Roles
    description: Manage workspace-level roles for billing rate configuration.
paths:
  /client-roles/{id}:
    patch:
      tags:
        - Client Roles
      summary: Update a client role
      description: >-
        Linked client roles (where `workspaceRole` is not `null`) cannot be
        modified and will return a 409 ReadOnlyError. Delete and recreate to
        change linking.
      operationId: update-a-client-role
      parameters:
        - name: id
          in: path
          description: The client role `uuid`.
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the client role. Maximum 255 characters.
                isBillable:
                  type: boolean
                  description: Whether the role is billable.
                rate:
                  type:
                    - number
                    - 'null'
                  description: The billing rate for the role.
                currency:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The three-letter ISO currency code for the role. Maximum 3
                    characters.
                disciplineId:
                  type:
                    - string
                    - 'null'
                  description: The `uuid` of the discipline for this role.
                practiceId:
                  type:
                    - string
                    - 'null'
                  description: The `uuid` of the practice for this role.
                locationId:
                  type:
                    - string
                    - 'null'
                  description: The `uuid` of the location for this role.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientRole'
              examples:
                Result:
                  value:
                    id: d2f5a7b1-9c34-4e80-b6d1-3a8e0c5f72b4
                    name: Principal Engineer
                    isBillable: true
                    rate: 250
                    currency: USD
                    createdAt: '2025-08-22T09:41:17.563Z'
                    client:
                      id: d4e1b7a3-8c52-4f90-b6d3-1a9e0c7f45b8
                      name: Acme Corporation
                    discipline:
                      id: 5b8e2a1c-3d47-4f09-a6e3-8c0d2f1b47a9
                      name: Software Engineering
                    practice:
                      id: c9a3d5b7-1e48-4f63-b7d0-a2e1c8f92d56
                      name: Web Development
                    location:
                      id: e2b4c6a8-7f19-4d30-a5e1-9c3b0d8f62a7
                      name: New York
                    workspaceRole: null
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
              examples:
                InvalidId:
                  value:
                    status: 400
                    message: Parameter 'id' is not a valid UUID.
                Validation:
                  value:
                    status: 400
                    message: >-
                      There was a problem processing your request. See errors
                      for more details.
                    errors:
                      - '''name'' must be a string'
                InvalidData:
                  value:
                    status: 400
                    message: >-
                      'disciplineId' 'a3c7e1b5-4d29-4f86-b0a8-6e2d9c1f73b4' does
                      not match a valid discipline.
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Feature:
                  value:
                    status: 403
                    message: Feature 'Workspace and Client Rate Cards' is not enabled.
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NotFound:
                  value:
                    status: 404
                    message: >-
                      Object with id 'c8b5e2a1-3f47-4d90-81a6-d0e9f7c34b82' not
                      found.
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ReadOnly:
                  value:
                    status: 409
                    message: Object cannot be modified because it is read-only.
                Duplicate:
                  value:
                    status: 409
                    message: >-
                      A Client Role with the same name, practice and location
                      already exists.
      deprecated: false
components:
  schemas:
    ClientRole:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the object.
        name:
          type: string
          description: >-
            The name of the client role. Reflects the workspace role's name when
            linked.
        isBillable:
          type: boolean
          description: >-
            Whether the role is billable. Reflects the workspace role's value
            when linked.
        rate:
          type:
            - number
            - 'null'
          description: >-
            The billing rate for the role. `null` when the role is non-billable.
            Reflects the workspace role's value when linked.
        currency:
          type:
            - string
            - 'null'
          description: >-
            The three-letter ISO currency code for the role. `null` when the
            role is non-billable. Reflects the workspace role's value when
            linked.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the object was created.
        client:
          type: object
          description: The client this role belongs to.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the client.
        discipline:
          type:
            - object
            - 'null'
          description: >-
            The discipline associated with this role. Reflects the workspace
            role's value when linked.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the discipline.
        practice:
          type:
            - object
            - 'null'
          description: >-
            The practice associated with this role. Reflects the workspace
            role's value when linked.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the practice.
        location:
          type:
            - object
            - 'null'
          description: >-
            The location associated with this role. Reflects the workspace
            role's value when linked.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the location.
        workspaceRole:
          type:
            - object
            - 'null'
          description: >-
            The workspace role this client role is linked to. When linked, the
            client role's name, billing fields, and classification fields are
            overridden with the workspace role's current values. `null` for
            standalone client roles.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the workspace role.
    ValidationErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
        errors:
          type: array
          description: A list of validation error messages.
          items:
            type: string
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````