HUhubstaff
invite_links

Create invite link

Creates a new invite link. Anyone with the returned url can join the organization.

At least one project or team must be assigned to the link.

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
post/v2/organizations/{organization_id}/invite_links

Request

Path parameters

organization_idinteger required

Request body

namestring required

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 (link never expires when omitted)

use_capinteger

Maximum number of joins allowed (unlimited when omitted)

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.