Skip to main content
POST
Create an invite link

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Body

application/json

Create a campaign/program invite link. programId is required; companyId is server-resolved from the token tenant. Only 'campaign' invites are supported on this surface.

programId
string
required
Minimum string length: 1
type
enum<string>
Available options:
campaign
expiresInDays
number | null
maxUses
number | null
label
string
paymentStructure
object
requirements
object

Response

The created invite link.

data
object
required