Skip to main content
PATCH
Update a template

Authorizations

Authorization
string
header
required

Secret API key, created in the dashboard under Settings → API. Send it as Authorization: Bearer rk_secret_… from your server only. Publishable keys (pk_live_…) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.

Path Parameters

slug
string
required

Template slug — lowercase [a-z0-9-].

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"warehouse-intake"

Body

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

Full plain-text message shown after submitting content. HTML, markdown and variables are not interpreted. Omit on create or send null on PATCH to use the default.

Required string length: 1 - 2000
identification
object | null
database
object | null
requires_location
boolean

Response

Updated template — version reflects whether the patch touched the snapshot.

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
org_slug
string
public_url
string<uri>
metadata
object
expected_info
object
expected_location
object
expected_object
object
condition_aspects
any[]
brand_slug
string
notify_email
string<email>
notify_subject_template
string
notify_body_template
string
completion_message
string

Full plain-text message shown after submitting content. HTML, markdown and variables are not interpreted. Omit on create or send null on PATCH to use the default.

Required string length: 1 - 2000
identification
object
requires_location
boolean
database
object
daily_cap
integer
total_cap
integer