Skip to main content
POST
/
web
/
template
/
{key}
/
publish
Publish Web template
curl --request POST \
  --url https://platform.inklink.com/api/v1/web/template/{key}/publish \
  --header 'api-key: <api-key>'
{
  "id": "<string>",
  "key": "<string>",
  "version": 123,
  "is_latest": true,
  "status": "draft",
  "name": "<string>",
  "description": "<string>",
  "query": "<string>",
  "fields": [
    {
      "name": "<string>",
      "required": true,
      "description": "<string>"
    }
  ],
  "user_instruction": "<string>",
  "acceptance_guide": "<string>",
  "start_url": "<string>",
  "return_url": "<string>",
  "capture_type": "screenshot",
  "settings": {
    "show_acceptance_guide": true,
    "show_cover_page": true
  },
  "metadata": {},
  "theme_id": "<string>",
  "org_id": "<string>",
  "created_by": "<string>",
  "published_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

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.

Headers

​
api-key
string
required
Example:

"secret_live_xxx"

Path Parameters

​
key
string
required

Template key (web_tpl_key_...).

Response

Template published (response body is the published row; check is_latest and status).

Web inquiry template row. Responses omit ai_instruction, login_methods, and allowed_modes even if set in the request body.

​
id
string

Row id (web_tpl_...).

​
key
string

Use as template_key on Create Web inquiry.

​
version
integer
​
is_latest
boolean
​
status
enum<string>
Available options:
draft,
published
​
name
string
​
description
string
​
query
string
​
fields
object[]
​
user_instruction
string
​
acceptance_guide
string
​
start_url
string
​
return_url
string
​
capture_type
enum<string>
Available options:
screenshot,
document
​
settings
object
​
metadata
object
​
theme_id
string | null
​
org_id
string
​
created_by
string
​
published_at
string<date-time> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time> | null