Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.inklink.com/llms.txt

Use this file to discover all available pages before exploring further.

A Web inquiry template stores the capture configuration your organization reuses when creating inquiries: query, URLs, fields, acceptance guide, capture type, and more. Each template has a stable key (for example web_tpl_key_…) that you pass as template_key on Create Web inquiry so the inquiry inherits that configuration.
Use templates so you only pass subject_id and template_key when creating inquiries, or to keep product and compliance text in one place. See the Quickstart for the end-to-end flow.

​
Draft and published

  • Draft – Editable working copy. New templates default to draft unless you set status to published on create.
  • Published – The version that template_key resolves to for new inquiries. Only published templates should be referenced from POST /web/inquiry (draft templates will not resolve for inquiries).
You can build templates in the InkLink dashboard or entirely via the Template API below.

​
API workflow

Typical first-time flow:
  1. Create template – POST /web/template. The server assigns key. The public API requires non-empty query, start_url, and return_url. You may set status to published to skip a separate publish step, or leave the default draft.
  2. Update draft – PATCH /web/template/{key} to change the current draft row (partial body; settings and metadata are shallow-merged with existing values).
  3. Publish – POST /web/template/{key}/publish to make the draft the latest published version and the one used for new inquiries.
When you already have a published version and need another edit cycle without overwriting production immediately:
  1. Create draft from published – POST /web/template/{key}/draft (optional field overrides in the body). Fails with 409 if a draft already exists; publish the existing draft first.
  2. Patch the draft, then publish again.

​
Listing and versions

  • List templates – GET /web/template returns a paginated list of all template rows in your organization (not only the latest per key), ordered newest first. Use for auditing or building admin UIs; filter client-side if you only need is_latest rows.
  • Get template versions – GET /web/template/{key} returns every version of that key (newest version first).

​
Template API

PageUse case
List Web templatesPaginate template rows (after_id, limit)
Create Web templateNew template; server assigns key
Get Web template versionsAll versions for one key
Update Web template draftPatch the current draft
Create Web template draft from publishedNew draft version from published
Publish Web templatePromote draft to published
Error responses follow the same shape as the rest of the platform. See Error handling. For example, list pagination returns VALIDATION_ERROR with INVALID_AFTER_ID on after_id when the cursor id is missing or not in your organization, similar to List Web inquiries.

​
Next steps

Create Web inquiry

Use template_key after publishing a template.

Quickstart

Hosted capture and return URL flow.