Skip to main content
A custom Object pairs an entity in your system with a permanent scan URL of the form https://award.ee/o/{public_slug}. This page is the field-by-field reference for the wire format returned by every objects endpoint.

​
Identifiers

​
string
required
Always "object". Sentinel that identifies the resource type on responses.
​
string
required
Bare UUID. Stable for the lifetime of the row.
​
string
required
Free-form category you control: "vehicle", "ticket", "asset", "contact", etc. Letters, numbers, and hyphens only (1–64 chars). Used as a namespace in variable substitution ({{object.<type>.<key>}}).
​
string | null
Your identifier. Unique per (org_id, external_id). Pass it on POST for idempotent upsert. null for objects created without one.
​
string
required
Short opaque slug minted on insert. Used to build the scan URL. Immutable, and never reused after delete.
​
string
required
Full scan URL, e.g. https://award.ee/o/a1b2c3d. Derived from public_slug — included as a convenience so you don’t have to build it.
​
string | null
Human-readable label. Shown in the dashboard. Not displayed to scan visitors by default.
​
string | null
Free-form description. Internal-only.
​
object
required
Free-form JSON blob you own. Use it to stash CRM context, attributes, or anything else integration-specific. Defaults to {}. Not searchable.

​
Destination

​
object
required
Where the scan URL routes. Exactly one of the companion fields should be populated for each type.

​
Knowledge

Knowledge linked to this object itself, on top of the chatbot’s own. When a visitor scans it and lands on a chatbot, the chatbot searches its own knowledge plus these articles and folders, so item-specific content (the manual for the TV in one room) lives here instead of on the shared chatbot. See Scan-specific knowledge.
​
string[]
required
UUIDs of Articles linked to this object. Write the desired set with article_ids and the join is fully replaced.
​
string[]
required
UUIDs of Article Categories linked to this object. Every article inside a linked category and its sub-categories (now and in future) is included.
article_ids and category_ids are replace-only. Send the full desired set every time; omit a field to leave it untouched; pass [] to detach everything. Every id must belong to your organization, or the request is rejected with 422 unprocessable. Linked knowledge only applies while this object sends visitors to a chatbot.

​
State

​
boolean
required
Master switch. When false, the scan URL still resolves but is treated as paused.

​
Stats

​
number
required
All-time scan count for the row. Increments in real time.
​
string | null
RFC 3339 timestamp of the most recent scan. null if never scanned.

​
Timestamps

​
string
required
RFC 3339 creation timestamp.
​
string
required
RFC 3339 timestamp of the last update to this row.

​
Example

​
Sub-resources

Properties and URL params live at their own endpoints and have their own reference shape: