HUhubstaff
invite_links

Update invite link

Updates an invite link. Only pass in the fields you want to change.

Pass enabled: false to disable the link and enabled: true to enable it back. A link can only be enabled while it is assigned to at least one active project or a team.

Pass pay_rate: null to remove the pay rate (requires the manage financials permission).

Only available to organization owners and managers with the invite members permission.

Available roles:

  • project_user - Invited as a project user
  • project_viewer - Invited as a project viewer
put/v2/invite_links/{invite_link_id}

Request

Path parameters

invite_link_idinteger required

Invite link ID

Request body

namestring

The invite link name (unique per organization)

role'project_user' | 'project_viewer'

The role users joining via the link will be added as

expires_onstring date

Expiration date

use_capinteger

Maximum number of joins allowed

project_idsinteger[]

List of project IDs users are added to when joining via the link

team_idsinteger[]

List of team IDs users are added to when joining via the link

pay_ratenumber float

A pay rate to set for users joining via the link

enabledboolean

Whether the link is enabled

Response

An invite link

Changes

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