Import a help center into the knowledge base
Bulk-import an existing help center: enumerate a provider’s published articles (Zendesk Guide’s public Help Center API — no OAuth) and queue one URL-sourced document per article through the standard ingest pipeline. subdomain is a strict DNS label, so the only host the connector can fetch is <subdomain>.zendesk.com. Returns 201 with the queued document rows. If the help center reports no published articles nothing is created, so the call succeeds with 200 instead — same envelope, plus queued: 0, an empty documents array, and a message naming what to check. Treat BOTH 200 and 201 as success.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
1 - 255Sandbox 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.
true, false Body
The lowercase DNS label in <subdomain>.zendesk.com (letters, digits, hyphens; max 63 chars). This is the only host the connector can ever fetch.
1 - 63Help-center provider to enumerate. Only Zendesk Guide is importable without OAuth today.
zendesk_guide Help-center locale segment, e.g. en or en-us. Defaults to en-us.
Optional prefix prepended to each imported document's name (max 80 chars).
80Upper bound on the number of articles queued in one import (1-1000). Defaults to 250.
1 <= x <= 1000Response
Successful response.