Skip to main content
POST
Import a help center into the knowledge base

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
subdomain
string
required

The lowercase DNS label in <subdomain>.zendesk.com (letters, digits, hyphens; max 63 chars). This is the only host the connector can ever fetch.

Required string length: 1 - 63
provider
enum<string>
default:zendesk_guide

Help-center provider to enumerate. Only Zendesk Guide is importable without OAuth today.

Available options:
zendesk_guide
locale
string
default:en-us

Help-center locale segment, e.g. en or en-us. Defaults to en-us.

name_prefix
string

Optional prefix prepended to each imported document's name (max 80 chars).

Maximum string length: 80
max_articles
integer
default:250

Upper bound on the number of articles queued in one import (1-1000). Defaults to 250.

Required range: 1 <= x <= 1000

Response

Successful response.

data
object

Nothing was queued: the help center reported no published articles. Carries the provider and subdomain echoed, queued: 0, truncated, an empty documents array, and a message naming what to check (the subdomain, the locale, and that the help center is public).

meta
object