Skip to main content
POST
Create a program invite link

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string
required

ID of the program

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Body

application/json
expiresInDays
integer | null

Days before the link expires (null for never, max 90)

Example:

14

maxUses
integer | null

Maximum link uses (null for unlimited)

Example:

50

Response

Invite link was created successfully

success
boolean

Complete invite URL

token
string

Token for the invite

expiresAt
string<date-time> | null
maxUses
integer | null
programId
string
programName
string