Members

Update a member

patch/members/{id}

Request

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

Path parameters

idstring required

The member uuid

Request body

namestring

The name of the member. Max 255 chars.

emailstring

The email address of the member. Must be unique between all members. Max 255 chars.

isActiveboolean

Whether the member is active in the workspace.

isBillableboolean

Whether the member is billable.

loginEnabledboolean

Whether the member can log into the workspace.

employmentTypeId'employee' | 'contractor' | 'other'

The type of employment for this member.

defaultRatenumber

The default bill rate for the member.

defaultRateCurrencystring

The currency code for the default rate.

activeStartDatestring date

The active start date (YYYY-MM-DD) of the member. Must come on or before activeEndDate if set.

activeEndDatestring date

The active end date (YYYY-MM-DD) of the member. Must come on or after activeStartDate if set.

timeOffAllowedboolean

Whether the member is allowed to create time-off time entries.

allowedTimeOffTypes'all' | 'custom'

Controls which time off types are allowed for time-off entries.

timeOffApprovalMode'auto' | 'manager' | 'member'

The approval mode for time-off time entries. If set to "manager" then managerId is required. If set to "member" then timeOffApproverId is required.

internalExpenseApprovalMode'auto' | 'manager' | 'member'

The approval mode for internal expense items. If set to "manager" then managerId is required. If set to "member" then internalExpenseApproverId is required.

receiveMissingTimeRemindersboolean

Whether the member receives missing time reminders.

unsubmittedTimesheetRemindersboolean

Whether the member receives reminders for unsubmitted timesheets.

automaticTimesheetSubmissionConfirmationboolean

Whether the member receives confirmation emails when timesheets are automatically submitted.

forbidTimesheetSubmissionWhenBelowCapacityboolean

Deprecated. Sets timesheetCapacityPolicy to "timesheet" when true or "unrestricted" when false. Use timesheetCapacityPolicy instead.

timesheetCapacityPolicy'unrestricted' | 'timesheet' | 'week'

The timesheet capacity policy.

internalIdstring

An extra identifier field for tracking this member against other systems. Must be unique between all members. Max 255 chars.

internalNotesstring

An area to store extra notes about the member. Max 5000 chars.

trackTimeByDurationboolean

Whether the member can track time by entering a duration.

trackTimeByTimeRangeboolean

Whether the member can track time by entering a start and end time.

securityRoleIdstring

The ID (uuid) of the security role for this member.

jobTitleIdstring

The ID (uuid) of the job title for this member.

memberLevelIdstring

The ID (uuid) of the member level for this member.

disciplineIdstring

The ID (uuid) of the discipline for this member.

businessUnitIdstring nullable

The ID (uuid) of the business unit for this member. Ignored when the Business Units feature is not enabled.

practiceIdstring

The ID (uuid) of the practice for this member.

locationIdstring

The ID (uuid) of the location for this member.

managerIdstring

The member ID (uuid) of the manager for this member. Required if timeOffApprovalMode is "manager".

timeOffApproverIdstring

The member ID (uuid) of the time off approver for this member. Required if timeOffApprovalMode is "member".

internalExpenseApproverIdstring

The member ID (uuid) of the internal expense approver for this member. Required if internalExpenseApprovalMode is "member".

holidayScheduleIdstring

The ID (uuid) of the holiday schedule for this member.

tagIdsstring[]

A list of member tag IDs (uuid) associated with this member.

certificationIdsstring[]

A list of member certification IDs (uuid) associated with this member.

skillIdsstring[]

A list of member skill IDs (uuid) associated with this member.

timeOffTypeIdsstring[]

A list of time off type IDs (uuid) associated with this member. allowedTimeOffTypes must be set to "custom".

Response

200

idstring

The unique identifier for the object.

namestring

The name of the member.

emailstring

The email address of the member.

isActiveboolean

Whether the member is active in the workspace.

isBillableboolean

Whether the member is billable.

loginEnabledboolean

Whether the member can log into the workspace.

invitationStatusId'not_invited' | 'invited' | 'accepted'

The invitation status of the member.

employmentTypeId'employee' | 'contractor' | 'other'

The type of employment for this member.

costMethodId'hourly' | 'fixed_hourly' | 'fixed_monthly'

Deprecated. The cost method for the member. Use costPeriods instead.

defaultRatenumber nullable

The default bill rate for the member.

defaultRateCurrencystring nullable

The currency code for the default bill rate.

activeStartDatestring date nullable

The start date of the member's active period. Will be in the form YYYY-MM-DD.

activeEndDatestring date nullable

The end date of the member's active period. Will be in the form YYYY-MM-DD.

timeOffAllowedboolean

Whether the member is allowed to create time-off time entries.

allowedTimeOffTypes'all' | 'custom'

Controls which time off types this member can use for time-off entries.

timeOffApprovalMode'auto' | 'manager' | 'member'

The approval mode for time-off time entries.

internalExpenseApprovalMode'auto' | 'manager' | 'member'

The approval mode for internal expense items.

receiveMissingTimeRemindersboolean

Whether the member receives missing time reminders.

unsubmittedTimesheetRemindersboolean

Whether the member receives reminders for unsubmitted timesheets.

automaticTimesheetSubmissionConfirmationboolean

Whether the member receives confirmation emails when timesheets are automatically submitted.

timesheetCapacityPolicy'unrestricted' | 'timesheet' | 'week'

The timesheet capacity policy for this member.

internalIdstring nullable

An identifier for tracking this member against other systems.

internalNotesstring nullable

Extra notes about the member.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

trackTimeByDurationboolean

Whether the member can track time by entering a duration. This is the effective value combining the workspace and member settings.

trackTimeByTimeRangeboolean

Whether the member can track time by entering a start and end time. This is the effective value combining the workspace and member settings.

forbidTimesheetSubmissionWhenBelowCapacityboolean

Legacy. A computed flag derived from timesheetCapacityPolicy. true when the policy is "timesheet" or "week". Use timesheetCapacityPolicy instead.

Changes

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