Create invite for a program

POST /programs/{id}/invites

Error

A valid request URL is required to generate request examples

201

{
  "data": {},
  "meta": {
    "requestId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Headers

Idempotency-Key · string

Client generated idempotency key (recommended for create/financial operations).

Path Parameters

id · string<uuid> · required

Body

application/json

name · string

Maximum string length: 100

email · string<email>

isPublic · boolean · default: false

usageLimit · integer

Required range: 1 <= x <= 1000

expiresInDays · integer

Required range: 1 <= x <= 365

trackingCode · string

Custom tracking code for the invite link

Required string length: 3 - 50

Pattern: ^[a-zA-Z0-9_-]+$

skipOnboarding · boolean

Skip onboarding flow when affiliate claims invite

Response

201 - application/json

Success response

data · object · required

meta · object · required

Show child attributes