Skip to main content
POST
Issue a capture-link token

Authorizations

Authorization
string
header
required

Bearer API key. Two modes: sv_live_* for production data, sv_test_* for a parallel sandbox dataset that doesn't count against plan limits. Issued from Settings → Developers in the SiteVisit app.

Headers

Idempotency-Key
string

Optional idempotency key, scoped to the authenticated account. Repeating a write with the same key + same body returns the original response; same key + different body returns 422 idempotency_key_in_use.

Maximum string length: 255

Body

application/json
target_type
enum<string>
required
Available options:
action_item,
action_item_completion
target_id
string
required
ttl_hours
integer
default:24
Required range: 1 <= x <= 168
upload_limit
integer
default:20
Required range: 1 <= x <= 100

Response

Capture token issued.

token
string
required
capture_url
string<uri>
required
expires_at
string<date-time>
required
upload_limit
integer
required