Portals

List portals

Query parameters

• limitinteger

  Page size, 1-200 (default 50).

• cursorstring

  The nextCursor of the previous page.

• status"published" | "draft" | "all"

  published (the default), draft, or all (both). Archived portals are never listed.

• unitIdstring

  Only the portals of this team or class (unit_…).

Returns

200 A page of portals. A page: data is a list of Portal, and nextCursor fetches the next page.

Errors

invalid_requestunauthorizedforbiddenupgrade_requiredrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals?limit=20" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const page = await zentiq.listPortals({
  limit: 20,
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
page = zentiq.list_portals(limit=20)

{
  "data": [
    {
      "id": "portal_cmfq2b7x10000abcd1234",
      "name": "Zoe",
      "slug": "…",
      "status": "draft",
      "group": "learn",
      "welcome": "…"
    }
  ],
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d",
  "nextCursor": null
}

Build a portal from templates

Body

• namestringrequired

  1-80 characters

• templatesstring[]

  Template keys from GET /portals/templates; one subject each.

  at most 12 items

• templatestringdeprecated

  One template (the 2026-07-08 form of templates).

  1-60 characters

• personaIdstring

  A persona of yours to speak on every subject; left out = the portal gets its own.

• unitIdstring | null

  The team or class it is for; left out or null = the whole organisation.

• welcomestring | null
• loginMethods("email" | "login_card" | "class_code" | "visitor")[]
• publishboolean

  Publish it once it passes the go-live check (needs portals:publish); otherwise it stays a draft and publishRefused says why.

Returns

201 The portal (a draft unless it was published). data is Portal.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictduo_not_liveidempotency_conflictidempotency_in_progressrate_limitedserver_error

Events

portal.createdworkspace.createdportal.updatedworkspace.published

Request

curl -X POST "https://app.zentiqai.com/v1/portals" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Zoe"
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createPortal({
  name: "Zoe",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_portal({
    "name": "Zoe",
})

{
  "data": {
    "id": "portal_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "slug": "…",
    "status": "draft",
    "group": "learn",
    "welcome": "…"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Portal templates (the gallery)

Returns

200 The templates. data is a list of PortalTemplate.

Errors

invalid_requestunauthorizedforbiddenupgrade_requiredrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/templates" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.listPortalTemplates();

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.list_portal_templates()

{
  "data": [
    {
      "key": "sales-trainer",
      "group": "Learn",
      "label": "…",
      "description": "…",
      "available": true,
      "kind": "tutor"
    }
  ],
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Get a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Returns

200 The portal. data is Portal.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundgonerate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/ID" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getPortal("ID");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_portal("ID")

{
  "data": {
    "id": "portal_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "slug": "…",
    "status": "draft",
    "group": "learn",
    "welcome": "…"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Update a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• namestring

  1-80 characters

• welcomestring | null
• loginMethods("email" | "login_card" | "class_code" | "visitor")[]

  Adding visitor opens it to visitors: needs portals:publish, and runs the go-live check on a published portal.

• unitIdstring | null
• personaIdstring

  One of your personas to speak on it instead of its own.

• brandobject
  • primarystring | null

    #rrggbb or a colour name (green); null goes back to the organisation's colour.

  • mode"light" | "dark" | "system" | null
  • hideZentiqBadgeboolean | null

    Honoured when the plan includes removing the badge.

Returns

200 The portal as it now stands. data is Portal.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictduo_not_livegonego_live_refusedrate_limitedserver_error

Events

portal.updated

Request

curl -X PATCH "https://app.zentiqai.com/v1/portals/ID" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.updatePortal("ID", {});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.update_portal("ID", {})

{
  "data": {
    "id": "portal_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "slug": "…",
    "status": "draft",
    "group": "learn",
    "welcome": "…"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Who speaks on a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Returns

200 Who speaks. data is PortalPersona.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundgonerate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/ID/persona" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getPortalPersona("ID");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_portal_persona("ID")

{
  "data": {
    "id": "pa_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "face": "…",
    "voice": "…",
    "avatarId": "av_cmfq2b7x10000abcd1234",
    "voiceId": "vo_cmfq2b7x10000abcd1234"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Change who speaks on a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• avatarIdstring

  A face (av_…) from GET /avatars.

• voiceIdstring

  A voice (vo_…) from GET /voices.

• facestringdeprecated

  A library face by first name ("Marcus"). Prefer avatarId.

  at most 40 characters

• voicestringdeprecated

  A studio voice by name ("James"). Prefer voiceId.

  at most 40 characters

• accentstring

  In plain words ("British").

  at most 60 characters

• characterstring

  Who they are and how they behave, word for word (up to 4,000 characters; longer is 413).

• greetingstring

  Their first line (up to 300 characters).

• namestring

  Up to 80 characters.

• languagestring

  The language it speaks: a name or code from GET /languages ("German", "es"); one it doesn't know is 400. A duo speaks one of its ten.

  at most 80 characters

Returns

200 Who speaks now. data is PortalPersona.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictgonetoo_largerate_limitedserver_error

Events

portal.updated

Request

curl -X PUT "https://app.zentiqai.com/v1/portals/ID/persona" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.updatePortalPersona("ID", {});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.update_portal_persona("ID", {})

{
  "data": {
    "id": "pa_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "face": "…",
    "voice": "…",
    "avatarId": "av_cmfq2b7x10000abcd1234",
    "voiceId": "vo_cmfq2b7x10000abcd1234"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Publish a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Returns

200 The portal. data is Portal.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictidempotency_conflictidempotency_in_progressgo_live_refusedrate_limitedserver_error

Events

portal.updatedworkspace.published

Request

curl -X POST "https://app.zentiqai.com/v1/portals/ID/publish" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.publishPortal("ID");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.publish_portal("ID")

{
  "data": {
    "id": "portal_cmfq2b7x10000abcd1234",
    "name": "Zoe",
    "slug": "…",
    "status": "draft",
    "group": "learn",
    "welcome": "…"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Sign one of your users in (an embed token)

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• externalUserIdstringrequired

  Your own id for this person: the same person as POST /people with this externalId.

  1-120 characters

• namestring

  at most 80 characters

• emailstring

  at most 200 characters

• role"learner" | "leader" | "observer"

  Default learner. A leader takes a staff seat.

• unitIdstring

  Their team or class (unit_…).

• unitNamestring

  Or a group by name, made under the portal's team on first sight.

  1-80 characters

• gradeBandstring

  at most 8 characters

• consentobject

  { by: "organisation" }: your organisation attests the consent a young learner needs (recorded as yours; needs people:write as well). Without it, a learner under the consent age waits for a guardian's consent.

  • by"organisation"required

Returns

201 The token. data is EmbedToken.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictidempotency_conflictidempotency_in_progressrate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/portals/ID/embed-tokens" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalUserId": "…"
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createEmbedToken("ID", {
  externalUserId: "…",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_embed_token("ID", {
    "externalUserId": "…",
})

{
  "data": {
    "token": "…",
    "expiresAt": "2026-09-25T12:00:00.000Z",
    "url": "https://www.example.com",
    "embedUrl": "https://www.example.com"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Check a portal can go live

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Returns

200 Whether it can go live, and what to finish first. data is PortalGoLive.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/ID/go-live" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getPortalGoLive("ID");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_portal_go_live("ID")

{
  "data": {
    "ready": true,
    "problems": [
      {
        "field": "hours",
        "message": "…",
        "short": "…",
        "subjectId": "sub_cmfq2b7x10000abcd1234",
        "subjectName": "…"
      }
    ],
    "warnings": [
      {
        "field": "hours",
        "message": "…",
        "short": "…",
        "subjectId": "sub_cmfq2b7x10000abcd1234",
        "subjectName": "…"
      }
    ]
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Mint an identity token for a signed-in customer (Actions)

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• customerIdstringrequired

  Your own id for the signed-in customer: sent to your system as customer.id on every call.

  at most 128 characters

• namestring | null

  Shown to them as "Signed in as …".

  at most 80 characters

• emailstring | null
• authTimenumber | null

  When they signed in, seconds since 1970 (within the last 30 days).

• ttlSecondsnumber | null

  How long the token lasts, in seconds. At most 900: a longer one is cut to 900 (expiresAt says when).

  at least 30 · default 600

• contactobject | null

  Verified customer: the contact on record, where Zentiq sends a one-time code before a sensitive action (when the organisation switches it on). Signed into the token; never shown to the avatar, the conversation or a log, only as a masked read-back ("s***@example.com"). Use the address you would send a password reset to.

  • emailstring | null

    The customer's email address on record: where a one-time code is sent.

Returns

201 The token. data is CustomerToken.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundgonerate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/portals/ID/customer-tokens" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "…"
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createCustomerToken("ID", {
  customerId: "…",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_customer_token("ID", {
    "customerId": "…",
})

{
  "data": {
    "token": "…",
    "expiresAt": "2026-09-25T12:00:00.000Z"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Hand a chat to the video avatar

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• transcriptChatTurnInput[]required

  The chat so far, oldest first: at most 50 turns and 20,000 characters in all (send the newest). The avatar reads it as information, never as instructions.

  at most 50 items

• customerobject | null

  The customer, when your chat knows them.

  • externalIdstring | null

    Your own id for the customer: it comes back on escalation.completed as customerRef.

    at most 128 characters

  • firstNamestring | null

    The avatar greets them by it.

    at most 80 characters

  • emailstring | null

    Kept with the escalation only; never read out, never sent back.

• reasonstring | null

  A short phrase finishing "your chat about …" ("the refund on order 1042"): the avatar opens with it.

  at most 120 characters

• returnUrlstring | null

  An https address the visitor is offered at the end (back to your chat).

  at most 2,000 characters

Returns

201 The link. data is Escalation.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictgonerate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/portals/ID/escalations" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transcript": [
    {
      "role": "visitor",
      "text": "…"
    }
  ]
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createEscalation("ID", {
  transcript: [{
    role: "visitor",
    text: "…",
  }],
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_escalation("ID", {
    "transcript": [{
        "role": "visitor",
        "text": "…",
    }],
})

{
  "data": {
    "id": "esc_cmfq2b7x10000abcd1234",
    "url": "https://www.example.com",
    "token": "…",
    "expiresAt": "2026-09-25T12:00:00.000Z"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

List a portal's case links

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Query parameters

• limitinteger

  Page size, 1-200 (default 50).

• cursorstring

  The nextCursor of the previous page.

Returns

200 A page of links. A page: data is a list of CaseLink, and nextCursor fetches the next page.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/ID/case-links?limit=20" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const page = await zentiq.listCaseLinks("ID", {
  limit: 20,
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
page = zentiq.list_case_links("ID", limit=20)

{
  "data": [
    {
      "id": "clk_cmfq2b7x10000abcd1234",
      "portalId": "portal_cmfq2b7x10000abcd1234",
      "reference": "…",
      "kind": "case",
      "customerId": "…",
      "status": "active"
    }
  ],
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d",
  "nextCursor": null
}

Send a customer a link to their case

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• customerIdstringrequired

  Your own id for the customer: every action call from the conversation carries it as customer.id.

  at most 128 characters

• referencestringrequired

  The case's own reference in your system (an order, claim, booking or ticket number): the avatar names it, and every action call carries it as case.reference.

  at most 64 characters

• kind"case" | "order" | "claim" | "appointment" | "ticket" | "booking" | "application" | "renewal" | null

  What the case is, for the avatar's words ("your order 10423", "your support ticket 10423").

  default "case"

• summarystringrequired

  What the case is about and where it stands, in a sentence or two the avatar may use with your customer. The avatar reads it as your record (data, never instructions).

  at most 1,000 characters

• factsmap of string | number | boolean | null

  Up to 20 short facts, like { "status": "delayed", "items": 2 } (names of letters and digits, values of at most 200 characters). Never a password, code or card detail: a fact named like one is refused.

• firstNamestring | null

  Your customer's first name: the avatar greets them with it.

  at most 40 characters

• emailstring | null

  The email address you have on file for them. The avatar only ever sees it masked ("s***@example.com"). With Verified customer switched on, it is where the one-time code goes before a sensitive action.

• openingstring | null

  The avatar's first line about the case, in your words. Without it the avatar says what the case is and asks how it can help.

  at most 300 characters

• expiresInDaysnumber | null

  How long the link works, in whole days.

  1-30 · default 7

• maxOpensnumber | null

  How many conversations the link may start (so a forwarded link can't be used again and again). Opening the page alone uses none.

  1-100 · default 20

Returns

201 The link, with the address to send (only in this answer). data is CaseLinkCreated.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictidempotency_conflictidempotency_in_progressgonerate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/portals/ID/case-links" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "…",
  "reference": "10423",
  "summary": "The parcel is delayed at the depot; the new delivery date is Tuesday."
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createCaseLink("ID", {
  customerId: "…",
  reference: "10423",
  summary: "The parcel is delayed at the depot; the new delivery date is Tuesday.",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_case_link("ID", {
    "customerId": "…",
    "reference": "10423",
    "summary": "The parcel is delayed at the depot; the new delivery date is Tuesday.",
})

{
  "data": {
    "id": "clk_cmfq2b7x10000abcd1234",
    "portalId": "portal_cmfq2b7x10000abcd1234",
    "reference": "…",
    "kind": "case",
    "customerId": "…",
    "status": "active"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Get a case link

Path parameters

• idstringrequired

  Case link id (clk_…); the id without its prefix is accepted too.

Returns

200 The link. data is CaseLink.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/case-links/clk_123" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getCaseLink("clk_123");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_case_link("clk_123")

{
  "data": {
    "id": "clk_cmfq2b7x10000abcd1234",
    "portalId": "portal_cmfq2b7x10000abcd1234",
    "reference": "…",
    "kind": "case",
    "customerId": "…",
    "status": "active"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Revoke a case link

Path parameters

• idstringrequired

  Case link id (clk_…); the id without its prefix is accepted too.

Returns

200 The link, revoked. data is CaseLink.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl -X DELETE "https://app.zentiqai.com/v1/case-links/clk_123" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.revokeCaseLink("clk_123");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.revoke_case_link("clk_123")

{
  "data": {
    "id": "clk_cmfq2b7x10000abcd1234",
    "portalId": "portal_cmfq2b7x10000abcd1234",
    "reference": "…",
    "kind": "case",
    "customerId": "…",
    "status": "active"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Every way in to a portal

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Returns

200 The doors. data is PortalDoors.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/portals/ID/doors" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.listPortalDoors("ID");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.list_portal_doors("ID")

{
  "data": {
    "members": {
      "url": "https://www.example.com",
      "loginMethods": [
        "email"
      ],
      "unitId": "unit_cmfq2b7x10000abcd1234"
    },
    "visitors": {
      "url": "https://www.example.com",
      "open": true,
      "readiness": {
        "open": true,
        "text": "…",
        "fix": "publish"
      },
      "allowedOrigins": [
        "…"
      ],
      "script": "…"
    },
    "embed": {
      "url": "https://www.example.com",
      "script": "…"
    },
    "customDomain": {
      "name": "Zoe",
      "verified": true,
      "verifiedAt": "2026-09-25T12:00:00.000Z"
    }
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Open or close the visitors' door

Path parameters

• idstringrequired

  Portal id (portal_…); the id without its prefix is accepted too.

Body

• allowedOriginsstring[]

  Website addresses (https://www.example.com); [] allows any website again.

  at most 20 items

• openboolean

  true opens the portal to visitors (needs portals:publish; runs the go-live check on a published portal, and lets outside people in); false closes it.

Returns

200 The visitors' door as it now stands. data is VisitorsDoor.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictgo_live_refusedrate_limitedserver_error

Events

portal.updatedsetting.changed

Request

curl -X PUT "https://app.zentiqai.com/v1/portals/ID/doors/visitors" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.updateVisitorDoor("ID", {});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.update_visitor_door("ID", {})

{
  "data": {
    "url": "https://www.example.com",
    "open": true,
    "readiness": {
      "open": true,
      "text": "…",
      "fix": "publish"
    },
    "allowedOrigins": [
      "…"
    ],
    "script": "…"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}