Client Roles

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.

patch/client-roles/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/client-roles/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The client role uuid.

Request body

namestring

The name of the client role. Maximum 255 characters.

isBillableboolean

Whether the role is billable.

ratenumber nullable

The billing rate for the role.

currencystring nullable

The three-letter ISO currency code for the role. Maximum 3 characters.

disciplineIdstring nullable

The uuid of the discipline for this role.

practiceIdstring nullable

The uuid of the practice for this role.

locationIdstring nullable

The uuid of the location for this role.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the client role. Reflects the workspace role's name when linked.

isBillableboolean

Whether the role is billable. Reflects the workspace role's value when linked.

ratenumber nullable

The billing rate for the role. null when the role is non-billable. Reflects the workspace role's value when linked.

currencystring nullable

The three-letter ISO currency code for the role. null when the role is non-billable. Reflects the workspace role's value when linked.

createdAtstring date-time

The timestamp when the object was created.

Changes

No recorded changes to this operation across all 1 revision of this API.