HUhubstaff
members

Create organization member

Creates a new user and adds them to the organization as a member.

Returns the created member.

Available roles:

  • organization_manager - Organization manager
  • project_manager - Project manager
  • project_user - Project user
  • project_viewer - Project viewer

Available pay periods:

  • none - Disables automatic payments
  • weekly - Pay users weekly
  • twice_per_month - Pay users twice a month
  • biweekly - Pay users bi-weekly
  • monthly - Pay users monthly
post/v2/organizations/{organization_id}/members

Request

Path parameters

organization_idinteger required

Request body

role'organization_manager' | 'project_manager' | 'project_user' | 'project_viewer'

The role to add the user as

pay_ratenumber float

A pay rate to set for the user

view_onlyboolean

Create the member as view-only

pay_period'none' | 'weekly' | 'twice_per_month' | 'biweekly' | 'monthly'

Member pay period; values are the API symbols mapped in UserOrganization::PayPeriods (see list above). When timesheet_approval is true, required only if the organization has no default pay period; otherwise optional (omit to use the organization default where applicable).

period_week_dayinteger

When pay_period is set: day of the week when the pay period starts (0 Monday through 6 Sunday). Required for weekly or biweekly pay periods when the organization uses custom pay period dates.

period_start_dayinteger

When pay_period is set: day of the month when the pay period starts. Required for monthly or twice_per_month pay periods when the organization uses custom pay period dates.

period_second_start_dayinteger

When pay_period is set: day of the month when the second period starts for twice_per_month (31 = last day of the month). Required for that pay period when the organization uses custom pay period dates.

period_anchor_datestring date

When pay_period is set: anchor date for biweekly periods when the organization uses custom pay period dates.

timesheet_approvalboolean

Tri-state: true requires timesheet approval for the member, false disables it, and omitting the parameter inherits the organization default for new members.

project_idsinteger[]

List of project IDs to add the user

team_idsinteger[]

List of team IDs to add the user

Response

A member

Changes

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