Skip to main content
POST
Create an idempotent promotional credit claim

Authorizations

Authorization
string
header
required

Long-lived opaque API key minted by an approved user at /api. The secret is shown once, stored only as a SHA-256 digest, and disabled immediately when either the key or its API access grant is revoked.

Body

application/json
leadId
string
required
Required string length: 1 - 200
email
string<email>
required
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
variant
string
required
Required string length: 1 - 100
creditAmount
integer
required
Required range: 1 <= x <= 1000000

Response

An identical claim already existed

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
leadId
string
required
variant
string
required
creditAmount
integer
required
Required range: x <= 9007199254740991
status
enum<string>
required
Available options:
pending,
claimed,
cancelled
claimUrl
string
required
statusUrl
string
required
createdAt
string
required
claimedAt
string | null
required