Project Members

Create a project member

post/project-members

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/project-members
  • Auth: HTTP bearer

Request body

projectIdstring required

The project ID (uuid) for this project member.

memberIdstring required

The member ID (uuid) for this project member.

typeId'collaborator' | 'administrator'

The type of project member. Can be either "administrator" (Project administrator) or "collaborator" (Project collaborator). Defaults to "collaborator".

isActiveboolean

Whether the member is active on the project team. Only controls project-level participation; the returned value is false whenever the member is deactivated at the workspace level.

isBillableboolean

Whether the member is billable on this project. Only used if the project is not using roles.

ratenumber nullable

The member's billing rate for the project. Only used if the project is not using roles and the member is billable. When Project Rate Cards is enabled, the new member gets this value on every rate card.

overrideCostRateboolean

Whether to override this project member's cost rate at the project member level rather than using the workspace or member default. When Project Rate Cards is enabled, the new member gets this value on every rate card.

costCurrencystring nullable

The ISO 4217 currency code for the overridden cost rate. This will only get used if overrideCostRate is true. When Project Rate Cards is enabled, the new member gets this value on every rate card.

costPerHournumber nullable

The overridden cost per hour. This will only get used if overrideCostRate is true. When Project Rate Cards is enabled, the new member gets this value on every rate card.

overheadCostPerHournumber nullable

The overridden overhead cost per hour. This will only get used if overrideCostRate is true. When Project Rate Cards is enabled, the new member gets this value on every rate card.

estimatedBillableHoursnumber nullable

The number of billable hours to budget. This will only get used if not using roles and useBudget is true and budgetMode is "detailed" on the project.

estimatedNonBillableHoursnumber nullable

The number of non-billable hours to budget. This will only get used if not using roles and useBudget is true and budgetMode is "detailed" on the project.

estimatedMonthlyBillableHoursnumber nullable

The number of billable hours on the monthly budget. This will only get used if not using roles and useMonthlyBudget is true and monthlyBudgetMode is "detailed" on the project.

estimatedMonthlyNonBillableHoursnumber nullable

The number of non-billable hours on the monthly budget. This will only get used if not using roles and useMonthlyBudget is true and monthlyBudgetMode is "detailed" on the project.

roleIdsstring[]

A list of project role IDs (uuid) assigned to the member. Only used if the project is using roles.

Response

200

idstring

The unique identifier for the object.

typeId'collaborator' | 'administrator'

The project member type.

isActiveboolean

Whether the member is active on the project. Returns false when the member is deactivated on the project team or deactivated at the workspace level.

isBillableboolean nullable

Whether the member is billable on this project. Only used if the project is not using roles; otherwise billability is assigned at the role level and this field is null.

ratenumber nullable

The member's billing rate for the project. Only used if the project is not using roles and the member is billable; otherwise null. When Project Rate Cards is enabled, this is the rate on the rate card covering today; see rateCards for other periods.

overrideCostRateboolean

Whether this project member's cost rate is overridden at the project member level rather than using the workspace or member default. When Project Rate Cards is enabled, this is the value on the rate card covering today; see rateCards for other periods.

costCurrencystring nullable

The ISO 4217 currency code for the overridden cost rate. Only populated when overrideCostRate is true; otherwise null. When Project Rate Cards is enabled, this is the value on the rate card covering today.

costPerHournumber nullable

The overridden cost per hour for this project member. Only populated when overrideCostRate is true; otherwise null. When Project Rate Cards is enabled, this is the value on the rate card covering today.

overheadCostPerHournumber nullable

The overridden overhead cost per hour for this project member. Only populated when overrideCostRate is true; otherwise null. When Project Rate Cards is enabled, this is the value on the rate card covering today.

createdAtstring date-time

The timestamp when the object was created.

Changes

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