Skip to main content
POST
/
api
/
dashboard
/
integrations
/
zunkiree
/
connect
Connect Zunkiree
curl --request POST \
  --url https://api.example.com/api/dashboard/integrations/zunkiree/connect \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand_name": "<string>",
  "contact_email": "jsmith@example.com",
  "website_type": "<string>",
  "language": "<string>"
}
'
{
  "site_id": "<string>",
  "connected_at": "2023-11-07T05:31:56Z",
  "status": "connected",
  "widget_script": "<string>",
  "sync_key_pending": false,
  "webhook_pending": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

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

Headers

​
authorization
string | null
​
X-API-Key
string | null
​
X-Stella-Merchant-Id
string | null

Body

application/json

Body for POST /api/dashboard/integrations/zunkiree/connect.

brand_name is the only required field — Z6's /api/v1/admin/tenants requires it (admin_tenants.py:74). Everything else is optional pass- through; Z6 fills sensible defaults when omitted.

​
brand_name
string
required

Display name shown in the widget header.

Required string length: 1 - 120
​
contact_email
string<email> | null

Where Zunkiree-side lead-capture emails should go.

​
website_type
string | null

e.g. 'ecommerce', 'saas', 'healthcare'. Hint for Z6's default widget tone selection.

Maximum string length: 64
​
language
string | null

BCP-47 language tag, e.g. 'en', 'th-TH'.

Maximum string length: 8

Response

Successful Response

Response from POST /connect.

sync_key_pending=true iff push_sync_credentials failed after provision_tenant succeeded — the tenant exists on Z6 but Z6 doesn't know about Stella's sync key yet. Caller's recovery: hit POST /rotate-sync-key.

webhook_pending=true iff the optional register_webhook call at the end of /connect failed — non-blocking; widget functions without the subscription. No user-facing recovery in v1; Stella's inbound-from-Zunkiree storage isn't built yet anyway (S8 docstring).

​
site_id
string
required
​
connected_at
string<date-time>
required
​
status
string
default:connected

Always 'connected' on success; partial-state failures still return 201 + the *_pending flags below.

​
widget_script
string | null
​
sync_key_pending
boolean
default:false
​
webhook_pending
boolean
default:false