Members

Invite a member

Sends a workspace invitation email to the member. The member must have loginEnabled set to true and must not have already accepted the invitation. Rate limited to once every 5 minutes per member.

post/members/{id}/invite

Request

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

Path parameters

idstring required

The member uuid.

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.