Skip to content
HeyX API

Create Invite Link

Required scope: member_invite_link:create

The API key creator must be allowed to delegate every selected role and the optional initial team. expiresInHours defaults to 72 and is capped at 720. maxUses defaults to 25 and is capped at 1,000.

Generated Reference
POST /public-api/publicapi.v1.WorkspaceInvitation/CreateInviteLink

Creates a reusable workspace invitation link. The token is returned once. This operation is not idempotent and must not be blindly retried.

Request CreateInviteLinkRequest
Response CreateInviteLinkResponse

CreateInviteLinkRequest

Field Type Description
role_ids repeated string
team_id optional string
expires_in_hours int32 Defaults to 72 hours; maximum 30 days.
max_uses int32 Defaults to 25 uses; maximum 1000.

CreateInviteLinkResponse

Field Type
invite_link WorkspaceInviteLink

Related Types

WorkspaceInviteLink

Field Type
id string
token string
roles repeated RoleReference
team_id optional string
expires_at int64
created_at int64
max_uses int32
use_count int32

RoleReference

Field Type
id string
name string

Request

Section titled “Request”
{
  "roleIds": ["<role-id>"],
  "teamId": "<team-id>",
  "expiresInHours": 72,
  "maxUses": 25
}

The response contains the raw invitation token only for this creation. Protect it as a secret. This operation is not idempotent and must not be blindly retried after a timeout.

HeyX API