reseller

PUT /v1/reseller/support/desk

Change your support desk's settings.

All reseller endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/reseller/support/desk \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Switching the AI agent on needs a live key of your own for the chosen provider (or any provider when none is chosen); without one it is refused with a 422. Requires reseller.manage.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoWhich of your organizations this applies to.

Request body

NameTypeRequiredWhat it is
ai_enabledbooleanNo—
ai_providerstringNo—
website_urlstringNo—
instructionsstringNo—
knowledgestringNo—

Response

NameTypeRequiredWhat it is
ai_enabledbooleanYes—
ai_providerstringYesThe provider of your own key the agent uses; empty means your first connected key.
website_urlstringYes—
instructionsstringYes—
knowledgestringYes—
connected_providersstring[]YesThe providers you have a live AI key of your own for.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429