Skip to main content
POST
Create a campaign invite

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.

Path Parameters

id
string
required

Body

application/json
expiresInDays
number | null
maxUses
number | null
label
string
paymentStructure
object
requirements
object

Response

Invite created.

data
object
required