Skip to main content
POST
Publish a link template

Authorizations

rial_session
string
cookie
required

Dashboard / operator session cookie. Set by /v1/auth/google/callback after Google OAuth, JWT signed with the rotating rial-platform/session-signing HMAC. Read on every request the SPA makes with credentials: include. Browser-only — server-to-server callers use bearerApiKey instead.

Body

application/json
slug
string
required
Required string length: 2 - 40
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
name
string
required
Required string length: 1 - 80
steps
object[]
required
Minimum array length: 1
mode
enum<string>
default:capture
Available options:
capture,
audit,
hybrid
expires_in_seconds
integer
default:3600
Required range: 60 <= x <= 86400
status
enum<string>
default:active
Available options:
draft,
active
metadata
object
expected_location
string
Required string length: 1 - 300
expected_object
string
Required string length: 1 - 200
condition_aspects
string[]
Required array length: 1 - 6 elements
Required string length: 1 - 40
expected_info
object
daily_cap
integer
Required range: 1 <= x <= 10000
total_cap
integer
Required range: 1 <= x <= 1000000
brand_slug
string
Required string length: 2 - 40
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
identification
object
database
object

Response

Template published. version is always 1 on create.

slug
string
required
name
string
required
mode
enum<string>
required
Available options:
capture,
audit,
hybrid
steps
object[]
required
expires_in_seconds
integer
required
status
enum<string>
required
Available options:
active,
paused
started_total
integer
required
started_today
integer
required
version
integer
required
Required range: x >= 1
created_at
string<date-time>
required
updated_at
string<date-time>
required
metadata
object
expected_info
object
expected_location
object
expected_object
object
condition_aspects
any[]
brand_slug
string
identification
object
database
object
daily_cap
integer
total_cap
integer