Schemas

AddMembershipInput

• role"OWNER" | "ADMIN" | "AVATAR_BUILDER" | "WORKSPACE_ADMIN" | "LEADER" | "LEARNER" | "OBSERVER"required

  OWNER (never given or changed through the API), ADMIN, AVATAR_BUILDER, WORKSPACE_ADMIN (these four at the organisation level only), LEADER, LEARNER, OBSERVER.

• unitIdstring | null
• workspaceIdstring | null
• gradeBandstring | null
• ageBand"18+" | null

AgentAnswer

• answerstringrequired

  The assistant's written answer, from what the business has told it. Email addresses, phone numbers and payment or identity numbers are removed.

• urlstringrequired

  The assistant's own page, where a person can talk to it, book or reach the team.

• aiGeneratedtruerequired

  Always true: the answer is AI-generated (EU AI Act Article 50(2)). Say so when you pass it on.

AgentAskInput

• questionstringrequired

  One question, up to 800 characters. Leave out people's names and contact details: email addresses, phone numbers and payment or identity numbers are removed before it is read.

  1-800 characters

ApiKey

• idstringrequired

  API key id (key_…).

  pattern `^key_.*`

• namestringrequired
• prefixstringrequired

  The key's first characters, as shown in the console.

• scopesstring[]required

  The scopes as set on the key; [] or ["*"] is full access (sensitive scopes are added by name).

• apiVersion"2026-07-08" | "2026-10-01"required

  The contract the key speaks.

• createdBystring | nullrequired

  Who made it: a member (usr_…) or a key (key_…); null for older keys.

• lastUsedAtstring (date-time) | nullrequired
• revokedAtstring (date-time) | nullrequired
• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

AssessmentCompletedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• passedboolean | null
• percentnumber | null
• marksnumber | null
• outOfnumber | null
• passMarknumber | null
• questionSetobject | null
  • idstring | null
  • titlestring | null
• humanReviewboolean | null
• reviewboolean | null
• criticalFailboolean | null
• difficultystring | null
• finalboolean | null
• aiobject | null
  • passedboolean | null
  • percentnumber | null
  • marksnumber | null
• decisionstring | null
• voidedboolean | null
• reviewedboolean | null

AssignmentCompletedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• assignmentIdstring | null
• titlestring | null
• minutesnumber | null
• passboolean | null

AssignmentCreatedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• assignmentIdstring | null
• titlestring | null
• learnersinteger | null
• dueAtstring | null
• minutesnumber | null
• skillsstring[] | null
• focusobject | null
  • kindstring | null
  • idstring | null
  • titlestring | null
• difficultystring | null
• targetnumber | null

AssignmentStartedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• assignmentIdstring | null

AttemptGrantedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• reportIdstring | null
• incompleteboolean | null

AttestationRecordedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• questionSetobject | null
  • idstring | null
  • titlestring | null
• versioninteger | null
• documentIdsstring[] | null

Avatar

• idstringrequired

  Avatar id (av_…).

  pattern `^av_.*`

• namestringrequired
• kind"builtin" | "custom"required

  builtin: Zentiq's library; custom: your organisation's own.

• genderstring | nullrequired

  A library face's gender (female, male); null for your own pictures.

• ageBandstring | nullrequired

  A library face's age band (20s, 30s, 40s, 50s, 60s); null for your own.

• heritagestring | nullrequired

  A library face's heritage (white, black, indian, chinese, korean, japanese, thai, hispanic, middleeastern, mixed); null for your own.

• previewUrlstring | nullrequired

  The picture. A library face is public (usable in an <img>); your own needs your API key (or a console sign-in).

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• aiGeneratedtruerequired

  Always true: this avatar's video and voice in every session are AI-generated, and so is its picture unless it is a photo you uploaded (EU AI Act Article 50(2)).

AvatarInput

• namestring

  Default "Custom avatar".

• imageBase64string

  The picture as a data:image/… URI (PNG, JPEG or WebP).

• imageUrlstring (uri)

  Or a public https address to fetch it from (6 MB at most).

• consentConsentrequired

  Consent to clone a real person's voice or to make an avatar from their picture. Recorded with who confirmed it (the API key), when, a hashed IP address, the exact wording and its version. The organisation's owners can export records and withdraw them; a withdrawn voice or face stops starting new sessions.

BookingRequestedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• summarystring | null
• needstring | null
• budgetstring | null
• timelinestring | null
• contactobject | null
  • namestring | null
  • emailstring | null
  • phonestring | null
  • companystring | null
  • rolestring | null
  • preferredTimestring | null
  • locationstring | null
  • referencestring | null
• consentobject | null
  • purposestring | null
  • marketingboolean | null
  • textstring | null
  • versioninteger | null
  • atstring | null
  • givenboolean | null
• promisestring | null
• dueAtstring | null
• departmentstring | null
• verifiedboolean | null
• portalIdstring | null
• servicestring | null
• whenstring | null
• statusstring | null
• inboxItemIdstring | null

Candidate

• idstringrequired

  cand_…: the candidate's interview.

  pattern `^cand_.*`

• sessionIdstringrequired

  Session id (sess_…).

  pattern `^sess_.*`

• roleIdstringrequired

  Subject id (sub_…).

• portalIdstring | nullrequired
• inviteIdstring | nullrequired
• externalIdstring | nullrequired

  Your ATS's id from the invite.

• namestring | nullrequired

  Null once erased.

• emailstring | nullrequired
• phonestring | nullrequired
• interviewedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• minutesnumber | nullrequired
• typedbooleanrequired

  They typed instead of speaking.

• roundinteger | nullrequired
• withdrawnbooleanrequired

  They chose to end the interview: never scored.

• erasedbooleanrequired
• erasedAtstring (date-time) | nullrequired
• mustHaves"met" | "missed" | "unclear" | "none" | nullrequired

  The must-have requirements: all met, one missed, unclear (a person checks), or none set. Flagged for a person, never acted on. Null once erased.

• requirementsobject[]required

  Each requirement's result; never the answer. Empty once erased.

  • idstringrequired
  • metboolean | nullrequired
  • knockoutbooleanrequired
• scorenumber | nullrequired

  Only where the role shares scores, and never once erased; else null.

• band"strong" | "possible" | "below" | "unscored" | nullrequired

  Only where the role shares scores, and never once erased; else null.

• rankinteger | nullrequired

  Place by score among the role's candidates in the same round (1 = highest; erased and withdrawn candidates hold no place); only where the role shares scores.

• decisionobject | nullrequired

  The latest decision a person made; null while it awaits one.

  • value"invite" | "hold" | "decline"required

    decline is shown to people as "not progressing".

  • reason"must_haves" | "strong_answers" | "missing_must_have" | "stronger_candidate" | "more_evidence" | "withdrew" | "other" | nullrequired

    The reason code from the fixed list (a note is never given out).

  • decidedAtstring (date-time)required

    ISO 8601 UTC timestamp.

  • decidedByobject | nullrequired

    The member who decided (never an API key).

    • idstringrequired

      Person id (usr_…).

      pattern `^usr_.*`

• reviewsobjectrequired
  • countintegerrequired
  • requiredintegerrequired
  • recommendationsobject | nullrequired

    How many reviewers recommend advance, hold or do not advance. Only where the role shares scores (candidates.share_scores), and never once erased; else null.

    • advanceintegerrequired
    • holdintegerrequired
    • doNotAdvanceintegerrequired
• holdbooleanrequired

  A legal hold keeps their data past the role's retention.

• reviewRequestedbooleanrequired

  They asked for a review of the decision and no decision was recorded since.

• retentionExpiresAtstring (date-time) | nullrequired

  When their data is erased (null while held or once erased).

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

CandidateCompliance

• candidateIdstringrequired

  Candidate id (cand_…).

  pattern `^cand_.*`

• roleIdstringrequired

  Subject id (sub_…).

• laws("illinois" | "nyc" | "colorado")[]required

  The US hiring rules the pack applies to the role now: illinois, nyc, colorado.

• consentobject | nullrequired

  What the candidate read and agreed to at the start; null for an interview started before the pack was on for the role.

  • atstring (date-time) | nullrequired

    When the candidate agreed to take part and started.

  • shownAtstring (date-time) | nullrequired

    When the page with the notices was made for them.

  • noticesobject[]required
    • kind"aivia" | "nyc" | "colorado"required
    • versionstringrequired
    • fingerprintstringrequired

      SHA-256 of the notice's exact text as shown.

  • illinoisConsentbooleanrequired

    They gave the separate consent to the AI analysing their interview (Illinois).

• nycNoticeobject | nullrequired

  New York City: how the notice reached the candidate at least 10 business days before the interview.

  • via"posting" | "invite_email" | "invite_link" | "door_email"required

    posting (the date your job posting gave it), invite_email, invite_link or door_email.

  • noticeAtstring (date-time) | nullrequired
  • postedOnstring (date) | nullrequired
• requestsCandidateRequest[]required

CandidateDecisionInput

• decision"invite" | "hold" | "decline"required
• reason"must_haves" | "strong_answers" | "missing_must_have" | "stronger_candidate" | "more_evidence" | "withdrew" | "other"required

  must_haves, strong_answers, missing_must_have, stronger_candidate, more_evidence, withdrew or other (other needs a note).

• notestring

  Kept for the hiring team; never given out through the API or webhooks.

  at most 600 characters

• decidedBystringrequired

  The member who made the decision (usr_…). Their own hiring access applies, and a decline needs them to have opened the interview or reviewed it in Zentiq.

• sendOutcomeEmailboolean

  Email the candidate the outcome, with their link to ask for a review.

CandidateInterview

• idstringrequired

  Candidate id (cand_…).

  pattern `^cand_.*`

• sessionIdstringrequired

  Session id (sess_…).

  pattern `^sess_.*`

• roleIdstringrequired

  Subject id (sub_…).

• portalIdstring | nullrequired
• inviteIdstring | nullrequired
• externalIdstring | nullrequired

  Your ATS's id from the invite.

• namestring | nullrequired
• emailstring | nullrequired
• phonestring | nullrequired
• locationstring | nullrequired
• titlestringrequired

  The job, as the interview named it.

• roundinteger | nullrequired
• versioninteger | nullrequired

  The version of the role the interview ran on.

• level"relaxed" | "standard" | "rigorous" | nullrequired

  How demanding the interview was set to be (the same for every candidate of the role).

• panelbooleanrequired

  Two AI interviewers took turns.

• typedbooleanrequired

  They typed instead of speaking.

• practiceQuestionbooleanrequired

  It opened with an unscored practice question. Its answer is never kept, never in the transcript and never marked.

• startedAtstring (date-time) | nullrequired
• endedAtstring (date-time) | nullrequired
• interviewedAtstring (date-time)required

  When it ended and reached the hiring team.

• minutesnumber | nullrequired
• scoresSharedbooleanrequired

  The role shares scores (candidates.share_scores): the numbers below are filled in.

• scorenumber | nullrequired
• band"strong" | "possible" | "below" | "unscored" | nullrequired
• rankinteger | nullrequired

  Place by score among the role's candidates in the same round (1 = highest).

• mustHaves"met" | "missed" | "unclear" | "none"required
• requirementsobject[]required

  The must-have questions, with their answers.

  • idstringrequired
  • questionstringrequired
  • answerstring | nullrequired

    Their answer in a few words, as the interview heard it; null when it was never answered.

  • metboolean | nullrequired

    Whether it meets the requirement (decided in code); null when unclear: a person checks it.

  • knockoutbooleanrequired

    A must-have: not meeting it is flagged to the hiring team, never acted on.

  • whystring | nullrequired

    Why the role needs it, as the role says.

• questionsobject[]required

  The interview questions, in order, with the answers and what the platform found in them.

  • idstring | nullrequired

    The question's id in the role's question set.

  • nintegerrequired

    Its number in the interview ("Question 2 of 5").

    at least 1

  • questionstringrequired
  • answerstring | nullrequired

    What they said after the interviewer read the question, up to the next one, from the transcript; null when it can't be told or nothing is kept.

  • status"answered" | "skipped" | "asked"required
  • verdict"right" | "partial" | "not-yet" | nullrequired

    How the answer compares with what the role looks for. Only where the role shares scores.

  • marksnumber | nullrequired

    Marks given. Only where the role shares scores.

  • outOfnumber | nullrequired

    The marks the question carries.

  • notestring | nullrequired

    A short note on the answer, as the report wrote it.

  • redFlagboolean | nullrequired

    The answer showed one of the question's red flags (for a person to check). Only where the role shares scores.

  • hintsintegerrequired

    Hints the interviewer gave on it.

• summarystring | nullrequired

  The written summary for the hiring team.

• strengthsstring[]required
• concernsstring[]required

  Where the evidence was thin.

• competenciesobject[]required

  The role's competencies with their score (0-100) where there was evidence and the role shares scores.

  • idstringrequired
  • labelstringrequired
  • weightnumberrequired
  • scorenumber | nullrequired
• evidenceobject[]required

  What the report quotes from the interview, by competency.

  • competencyIdstringrequired
  • quotestring | nullrequired

    Their own words.

  • notestring | nullrequired
• transcriptobjectrequired
  • keptbooleanrequired

    false when the role keeps no transcripts (then turns is empty).

  • turnsobject[]required
    • speaker"ai" | "candidate"required

      ai: Zentiq's AI interviewer; candidate: the person.

    • namestring | nullrequired

      Which AI interviewer spoke, when two took turns; else null.

    • textstringrequired
    • offsetMsinteger | nullrequired

      Milliseconds from the start of the interview, when known.

• adjustmentsobjectrequired

  Whether they asked for an adjustment during the interview: make sure it was given. Never which one, nor why (it can reveal a disability): that stays with the hiring team in Zentiq.

  • requestedbooleanrequired
• reviewRequestobject | nullrequired

  They asked for a review of the decision (from the link in an outcome email); open until a person decides again.

  • requestedAtstring (date-time)required

    ISO 8601 UTC timestamp.

  • messagestring | nullrequired
  • openbooleanrequired
• reviewsobjectrequired
  • countintegerrequired
  • requiredintegerrequired

    Reviews a decision waits for (candidates.reviews_required).

  • blindbooleanrequired

    Blind review (candidates.blind_review): each reviewer sees the others' reviews only after adding their own.

  • hiddenBy"blind_review" | "scores_not_shared" | nullrequired

    Why items is null: the role's blind review, or its scores aren't shared.

  • itemsobject[] | nullrequired

    Each reviewer's recommendation and ratings, never their notes. Null while hidden.

• integrityobjectrequired

  Moments a recorded interview noted for a person to watch (how many, of which kinds), never part of the score. Their details stay in Zentiq.

  • countintegerrequired
  • kindsobject[]required
    • kind"face_out_of_view" | "another_person" | "left_page" | "pasted_text" | "camera_off" | "microphone_off" | "connection_dropped"required
    • countintegerrequired
• flagsobjectrequired

  Things the report asks a person to look at; their words stay in Zentiq.

  • countintegerrequired
• recorded"audio" | "audio_video" | nullrequired

  A recording exists (watch it in Zentiq); it is never given out.

• decisionobject | nullrequired

  The latest decision a person made; null while it awaits one.

  • value"invite" | "hold" | "decline"required

    decline is shown to people as "not progressing".

  • reason"must_haves" | "strong_answers" | "missing_must_have" | "stronger_candidate" | "more_evidence" | "withdrew" | "other" | nullrequired

    The reason code from the fixed list (a note is never given out).

  • decidedAtstring (date-time)required

    ISO 8601 UTC timestamp.

  • decidedByobject | nullrequired

    The member who decided (never an API key).

    • idstringrequired

      Person id (usr_…).

      pattern `^usr_.*`

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

CandidateRequest

• idstringrequired

  Candidate request id (creq_…).

  pattern `^creq_.*`

• kind"deletion" | "alternative" | "review" | "correction"required

  deletion (their interview, any recording and every copy), alternative (another way to be assessed, or an accommodation), review (a person to review a decision) or correction (their data corrected).

• status"open" | "paused" | "done"required

  open; paused while a legal hold keeps the interview (the candidate was told); done once answered, or (a deletion) once the interview was erased.

• roleIdstringrequired

  Subject id (sub_…).

• candidateIdstring | nullrequired

  The candidate whose interview it is about; null before an interview (an invitation) or from the door.

• inviteIdstring | nullrequired
• source"link" | "interview" | "door" | "outcome_email"required

  link: the candidate's own page; door: the interview's page; outcome_email: the review link in an outcome email.

• requestedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• dueAtstring (date-time)required

  When the hiring team is asked to have answered: 30 days for a deletion, a review or a correction, 14 for another way.

• autoDeleteAtstring (date-time) | nullrequired

  A deletion the role carries out automatically: when (day 30), unless a person acts first or a legal hold is on.

• overduebooleanrequired
• outcomestring (one of 10) | nullrequired

  What happened, once done: deleted, deleted_automatically, alternative_offered, accommodation_given, not_possible, withdrawn_by_candidate, decision_stands, decision_changed, data_corrected or nothing_to_correct.

• resolvedAtstring (date-time) | nullrequired

CandidateWebhookData

• eventIdstring | nullrequired
• statusstring | nullrequired
• candidateIdstring | nullrequired
• sessionIdstring | nullrequired
• inviteIdstring | null
• roleIdstring | nullrequired
• rolestring | null
• portalIdstring | null
• decisionstring | null
• recommendationstring | null
• reasonstring | null
• by"team" | "candidate" | null
• reviewerIdstring | null
• offerIdstring | null
• slotIdstring | null
• timingstring | null
• startAtstring | null
• opensAtstring | null
• lateAtstring | null
• deadlineAtstring | null
• rescheduledboolean | null
• occurredAtstring | nullrequired
• externalIdstring | null
• resentboolean | null

CandidateWithHistory

• idstringrequired

  cand_…: the candidate's interview.

  pattern `^cand_.*`

• sessionIdstringrequired

  Session id (sess_…).

  pattern `^sess_.*`

• roleIdstringrequired

  Subject id (sub_…).

• portalIdstring | nullrequired
• inviteIdstring | nullrequired
• externalIdstring | nullrequired

  Your ATS's id from the invite.

• namestring | nullrequired

  Null once erased.

• emailstring | nullrequired
• phonestring | nullrequired
• interviewedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• minutesnumber | nullrequired
• typedbooleanrequired

  They typed instead of speaking.

• roundinteger | nullrequired
• withdrawnbooleanrequired

  They chose to end the interview: never scored.

• erasedbooleanrequired
• erasedAtstring (date-time) | nullrequired
• mustHaves"met" | "missed" | "unclear" | "none" | nullrequired

  The must-have requirements: all met, one missed, unclear (a person checks), or none set. Flagged for a person, never acted on. Null once erased.

• requirementsobject[]required

  Each requirement's result; never the answer. Empty once erased.

  • idstringrequired
  • metboolean | nullrequired
  • knockoutbooleanrequired
• scorenumber | nullrequired

  Only where the role shares scores, and never once erased; else null.

• band"strong" | "possible" | "below" | "unscored" | nullrequired

  Only where the role shares scores, and never once erased; else null.

• rankinteger | nullrequired

  Place by score among the role's candidates in the same round (1 = highest; erased and withdrawn candidates hold no place); only where the role shares scores.

• decisionobject | nullrequired

  The latest decision a person made; null while it awaits one.

  • value"invite" | "hold" | "decline"required

    decline is shown to people as "not progressing".

  • reason"must_haves" | "strong_answers" | "missing_must_have" | "stronger_candidate" | "more_evidence" | "withdrew" | "other" | nullrequired

    The reason code from the fixed list (a note is never given out).

  • decidedAtstring (date-time)required

    ISO 8601 UTC timestamp.

  • decidedByobject | nullrequired

    The member who decided (never an API key).

    • idstringrequired

      Person id (usr_…).

      pattern `^usr_.*`

• reviewsobjectrequired
  • countintegerrequired
  • requiredintegerrequired
  • recommendationsobject | nullrequired

    How many reviewers recommend advance, hold or do not advance. Only where the role shares scores (candidates.share_scores), and never once erased; else null.

    • advanceintegerrequired
    • holdintegerrequired
    • doNotAdvanceintegerrequired
• holdbooleanrequired

  A legal hold keeps their data past the role's retention.

• reviewRequestedbooleanrequired

  They asked for a review of the decision and no decision was recorded since.

• retentionExpiresAtstring (date-time) | nullrequired

  When their data is erased (null while held or once erased).

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• decisionsobject[]required

  Every decision recorded, newest first.

  • value"invite" | "hold" | "decline"required

    decline is shown to people as "not progressing".

  • reason"must_haves" | "strong_answers" | "missing_must_have" | "stronger_candidate" | "more_evidence" | "withdrew" | "other" | nullrequired

    The reason code from the fixed list (a note is never given out).

  • decidedAtstring (date-time)required

    ISO 8601 UTC timestamp.

  • decidedByobject | nullrequired

    The member who decided (never an API key).

    • idstringrequired

      Person id (usr_…).

      pattern `^usr_.*`

CaseLink

• idstringrequired

  Case link id (clk_…).

  pattern `^clk_.*`

• portalIdstringrequired

  Portal id (portal_…).

• referencestringrequired
• kind"case" | "order" | "claim" | "appointment" | "ticket" | "booking" | "application" | "renewal"required
• customerIdstringrequired

  Your own id for the customer.

• status"active" | "expired" | "revoked" | "used_up"required

  active: it opens; expired: past expiresAt; revoked: switched off; used_up: every conversation it may start has started.

• opensintegerrequired

  Conversations started from it so far.

• maxOpensintegerrequired
• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

• revokedAtstring (date-time) | nullrequired
• lastOpenedAtstring (date-time) | nullrequired
• emailedAtstring (date-time) | nullrequired

  When your team emailed it from the console; null when it was sent some other way.

• source"api" | "console"required

  Made with an API key, or by your team in the console.

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

CaseLinkCreated

• idstringrequired

  Case link id (clk_…).

  pattern `^clk_.*`

• portalIdstringrequired

  Portal id (portal_…).

• referencestringrequired
• kind"case" | "order" | "claim" | "appointment" | "ticket" | "booking" | "application" | "renewal"required
• customerIdstringrequired

  Your own id for the customer.

• status"active" | "expired" | "revoked" | "used_up"required

  active: it opens; expired: past expiresAt; revoked: switched off; used_up: every conversation it may start has started.

• opensintegerrequired

  Conversations started from it so far.

• maxOpensintegerrequired
• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

• revokedAtstring (date-time) | nullrequired
• lastOpenedAtstring (date-time) | nullrequired
• emailedAtstring (date-time) | nullrequired

  When your team emailed it from the console; null when it was sent some other way.

• source"api" | "console"required

  Made with an API key, or by your team in the console.

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• urlstringrequired

  The link to send your customer (by email, text message or your app). Shown only now, never again: Zentiq keeps no copy it could show. Never put it in a public place.

CaseLinkInput

• 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

CaseLinkOpenedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• portalIdstring | null
• caseLinkIdstring | null
• caseReferencestring | null
• kindstring | null
• customerIdstring | null
• opensinteger | null
• maxOpensinteger | null
• channel"voice" | "chat" | null
• summarystring | null

CertificateIssuedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• idstring | null
• subjectstring | null
• percentnumber | null
• issuedAtstring | null
• versioninteger | null
• validUntilstring | null
• titlestring | null
• levelstring | null
• issuerstring | null
• showScoreboolean | null
• setIdstring | null

CertificateNoticeData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• certificateIdstring | null
• subjectstring | null
• titlestring | null
• validUntilstring | null
• renewalAssignmentIdstring | null

CertificateRevokedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• certificateIdstring | null
• reason"Attempt voided after review" | "Result changed after review" | null

ChatTurnInput

• role"visitor" | "agent" | "bot"required

  Who said it: the customer (visitor), a person on your team (agent) or your chat bot (bot).

• textstringrequired

  What they said: plain text.

  at most 4,000 characters

• atstring | number | null

  When it was said: an ISO 8601 date and time (or seconds since 1970).

CompletionRecordedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• kindstring | null
• percentnumber | null
• passMarknumber | null
• versioninteger | null
• setIdstring | null
• setTitlestring | null
• attemptinteger | null
• startedAtstring | null
• endedAtstring | null
• completedAtstring | null
• documentsobject[] | null
• documentsHashstring | null
• reviewedboolean | null
• reviewerIdstring | null
• decisionstring | null
• decidedAtstring | null

CompletionWithdrawnData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• reason"Attempt voided after review" | "Result changed after review" | null

Connection

• idstringrequired

  Connection id (conn_…).

• kind"mcp" | "calcom" | "hubspot" | "shopify" | "google_calendar" | "microsoft_calendar" | "slack" | "zapier"required
• namestringrequired

  The system, in words.

• labelstringrequired
• status"pending" | "active" | "failing" | "reconnect"required
• statusWordsstringrequired
• secretHintstringrequired

  The last four characters of its key, like "…4f2a" ("" when there is none): the only part of a key ever shown.

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• lastUsedAtstring (date-time) | nullrequired
• healthobjectrequired
  • callsintegerrequired
  • successRatenumber | nullrequired

    Calls the system answered, as a share of all (0 to 1); null before the first.

  • p50Msinteger | nullrequired

    The median time of the latest calls, in ms.

  • lastErrorobject | nullrequired
    • codestringrequired
    • wordsstringrequired
    • atstring | nullrequired
• detailsmap of string | number | booleanrequired

  What isn't secret: the server's host, the shop, the event type, the calendar.

ConnectionCreated

• connectionConnectionrequired

  One of the organisation's connected systems. Never a key or a token.

• authorizeUrlstring | nullrequired

  For a sign-in: where an owner approves it, signed in to the console. null when it is connected already.

ConnectionDeleted

• idstringrequired
• actionsOffintegerrequired

  Actions that used it, now switched off.

ConnectionFailedData

• connectionIdstring | null
• kindstring | null
• errorCodestring | null
• statusinteger | null

ConnectionInput

• kind"mcp" | "calcom" | "hubspot" | "shopify" | "google_calendar" | "microsoft_calendar" | "slack" | "zapier"required

  Which system.

• labelstring | null

  A plain name (never a key).

  at most 60 characters

• urlstring | null

  mcp: the server's public https MCP address (standard port; private and local addresses are refused).

• auth"none" | "bearer" | "oauth" | null

  mcp: how it signs in. oauth: the answer's authorizeUrl is where an owner approves it, signed in to the console.

• tokenstring | null

  mcp (bearer), hubspot (a private app's access token) or shopify (an older app's Admin API access token, made in the Shopify admin before 2026). Write-only: checked, sealed in the vault and never returned (only a masked hint).

• apiKeystring | null

  calcom: a Cal.com API key. Write-only: checked, sealed in the vault and never returned (only a masked hint).

• eventTypeIdstring | number | null

  calcom: the event type's number.

• timeZonestring | null

  calcom, google_calendar, microsoft_calendar: an IANA time zone, like America/New_York.

• shopstring | null

  shopify: the shop's address, like your-shop.myshopify.com.

• clientIdstring | null

  shopify: a Dev Dashboard app's Client ID (the app's Settings), with clientSecret instead of token. Zentiq asks Shopify for the app's 24-hour tokens itself (the client credentials grant: the store must be in the app's own Shopify organisation).

  at most 100 characters

• clientSecretstring | null

  shopify: a Dev Dashboard app's Client secret, with clientId. It also verifies the order notifications Shopify sends for order emails. Write-only: checked, sealed in the vault and never returned (only a masked hint).

• apiSecretstring | null

  shopify with token: the older app's API secret key, which only order emails need (Shopify signs its order notifications with it). Write-only: checked, sealed in the vault and never returned (only a masked hint).

• propertiesstring | string[] | null

  hubspot: the contact properties the avatar may read (HubSpot's own names).

• calendarIdstring | null

  google_calendar: which calendar ("primary" unless named).

• hoursmap of string | null

  google_calendar, microsoft_calendar: opening hours per day, like { "mon": "09:00-17:00" } (a day left out is closed).

• slotMinutesnumber | null
• lengthMinutesnumber | null
• titlestring | null

  google_calendar, microsoft_calendar: a booking's title.

  at most 60 characters

ConnectionList

• onbooleanrequired

  The organisation's actions.connectors switch: off, nothing connected is used and nothing new can be connected.

• connectionsConnection[]required

ConnectionTest

• okbooleanrequired
• wordsstringrequired
• connectionConnectionrequired

  One of the organisation's connected systems. Never a key or a token.

Consent

• attestedtruerequired

  You confirm the person agreed (or, with subject "generated", that the face is not a real person).

• subject"myself" | "someone_else" | "generated"required

  Whose face or voice it is. "generated" is for a face made by AI; a voice can't be generated.

• subjectNamestring

  Required with subject "someone_else": the person's name.

  2-120 characters

• textVersionstring

  Optional. When sent it must be the current wording version, or the request is refused with consent_outdated.

ConsentRecordedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• bystring | null

ConversationRatedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• ratingnumber | null
• commentstring | null

CreatedInvites

• createdInvite[]required
• skippedobject[]required
  • emailstringrequired
  • externalIdstring | nullrequired
  • reason"open_invite" | "already_interviewed" | "listed_twice"required
  • messagestringrequired
• emailobjectrequired
  • requestedbooleanrequired
  • sentintegerrequired
  • failedintegerrequired
  • queuedintegerrequired

    Still to go: sent straight after this answer.

CreateInvitesInput

• candidatesobject[]required

  At most 200, or 100 when Zentiq emails them. An address with an open invite for the role, one that completed the interview within its retention, or one listed twice is skipped.

  at most 200 items

  • namestringrequired

    2-120 characters

  • emailstringrequired

    at most 254 characters

  • phonestring | null
  • externalIdstring

    pattern `^[^\s@]{1,200}$`

  • metadatamap of string

    Your own data about the applicant, returned as it was: at most 20 string keys. Never sent by webhook.

• timingInviteTimingrequired

  When candidates may take the interview: any time, by a deadline, or at a set time.

• timeZonestring

  IANA time zone the emails' times read in (default Europe/London).

  at most 64 characters

• sendboolean

  true: Zentiq emails each candidate their link (with a calendar file for a set time, and reminders). false (default): copy the links yourself.

• portalIdstring

  The portal whose door the links open; default: the role's own (where it is published and open to visitors).

CreatePersonInput

• externalIdstring | null

  Your own id for the person: the sync key. A repeat with it returns the same person.

• emailstring (email) | null

  Without an externalId, the person is found or added by email. An email another account already has is refused (409).

• namestring | null
• role"OWNER" | "ADMIN" | "AVATAR_BUILDER" | "WORKSPACE_ADMIN" | "LEADER" | "LEARNER" | "OBSERVER"required

  OWNER (never given or changed through the API), ADMIN, AVATAR_BUILDER, WORKSPACE_ADMIN (these four at the organisation level only), LEADER, LEARNER, OBSERVER.

• unitIdstring | null
• workspaceIdstring | null

  A workspace admin's subject.

• gradeBandstring | null
• ageBand"18+" | null
• loginCardboolean | null

  A learner without an email gets a login card (needs accounts without email switched on).

CreateUnitInput

• namestringrequired

  1-80 characters

• parentIdstring | null
• kindstring | null

  class, team, group, department, region, school or club (default: the organisation's).

• gradeBandstring | null
• leaderobject | null

  Invites the unit's leader by email (takes a staff seat).

  • emailstring (email)required

CustomerToken

• tokenstringrequired

  zct1.…: for this portal and one conversation only. Give it to the website widget or a conversation's start; never put it in a URL.

• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

CustomerTokenInput

• 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.

Dashboard

• idstring
• namestring
• slugstring
• status"draft" | "published" | "archived"
• welcomestring | null
• addressstring

  Where people open it: /d/<org>/<slug>, or the verified custom domain.

• loginMethods("email" | "login_card" | "class_code" | "visitor")[]
• personaIdstring | null
• subjectsobject[]
  • idstring
  • namestring
  • typestring

    The template's blueprint key.

  • statusstring
• createdAtstring (date-time)
• updatedAtstring (date-time)
• publishRefusedstring

  Only on a publish that was refused (POST /portals with publish: true, POST /portals/{id}/publish): what to finish before the portal can go live. The portal stays a draft.

DashboardInput

• namestringrequired

  at most 80 characters

• templatesstring[]required

  Template keys from GET /portals/templates.

  at most 12 items

• personaIdstring

  A persona of yours to serve every subject; omitted = the portal gets its own.

• welcomestring

  at most 160 characters

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

  true publishes it once it passes the go-live check; otherwise, or when the check refuses it (see publishRefused), it stays a draft.

  default false

DashboardPersona

• namestring
• facestring | null
• voicestring | null
• accentstring | null
• greetingstring | null
• characterstring
• readyboolean

  true once it has a face and a voice: people can talk to it.

DashboardTemplate

• keystring
• group"Learn" | "Train" | "Serve" | "Assess"
• labelstring
• descriptionstring
• availableboolean

  Whether it can be built today.

Deleted

• deletedboolean
• idstring

DeliveryList

Type: object[]

Document

• idstringrequired

  Document id (doc_…).

  pattern `^doc_.*`

• knowledgeBaseIdstringrequired

  Knowledge base id (kb_…).

  pattern `^kb_.*`

• namestringrequired
• typestring | nullrequired

  pdf, txt, md, docx, csv, url or text.

• bytesinteger | nullrequired
• status"processing" | "ready" | "failed"required

  processing until it has been read; then ready, or failed.

• chunkCountinteger | nullrequired

  How many passages were read from it, once ready.

• errorstring | nullrequired

  When failed: one plain sentence (the file couldn't be read, took too long, reading is unavailable, or it couldn't be processed).

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

DocumentInput

• urlstring (uri)

  A public https address to fetch and read (25 MB at most; every redirect is checked too).

• textstring

  Text to read (1 MB at most).

  at most 1,048,576 characters

• namestring

  at most 200 characters

DocumentUpload

• filestring (binary)required

  pdf, txt, md, docx or csv; 25 MB at most.

• namestring

DoorReadiness

• openbooleanrequired
• textstringrequired

  The readiness line, in plain words ("Public page open").

• fix"publish" | "visitors" | "organisation" | nullrequired

  What to do when it is closed: publish the portal, open it to visitors, or let outside people in (the organisation's public website switch).

DownloadUrl

• urlstringrequired

  A short-lived signed address of the original file.

• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

Duo

• idstringrequired

  Duo id (duo_…).

  pattern `^duo_.*`

• personaIdstringrequired

  The persona sessions and portals use (its name is "A & B").

  pattern `^pa_.*`

• source"library" | "generated" | "composed" | "upload"required

  Where its picture came from.

• libraryKeystring | nullrequired

  The ready-made duo it was copied from.

• peopleobject[]required
  • namestringrequired
  • gender"female" | "male"required
  • rolestring | nullrequired

    Their part in the conversation, in a few words.

  • voiceIdstring | nullrequired
• relationshipstring | nullrequired
• status"draft" | "ready_for_render" | "registering" | "testing" | "live" | "needs_changes" | "failed"required

  draft, then ready_for_render once published; registering and testing on the render side; live when its test run passed, or needs_changes / failed.

• statusWordsstringrequired

  Where it is, in one plain sentence.

• previewUrlstring | nullrequired

  Its picture (your API key reads it: it is the organisation's own avatar).

• languagesstring[]required

  The languages a duo speaks (the ten codes GET /languages marks duo).

• testReasonsstring[]required

  Why its test run didn't pass, in plain words (needs_changes, failed).

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• aiGeneratedtruerequired

  Always true: the duo's video and voices are AI-generated, and so is their picture unless it is a photo you uploaded (EU AI Act Article 50(2)).

DuoAccess

• builderOpenbooleanrequired

  Duos are open to the organisation (while not, every other /duos operation is 404).

• canUsebooleanrequired

  The plan uses ready-made duos.

• canBuildbooleanrequired

  The plan builds its own duos.

• upgradeobject | nullrequired

  The plan that would add what's missing, and the words for it; null when nothing is.

  • planstringrequired
  • messagestringrequired

DuoInput

• source"library"required

  A copy of one of Zentiq's ready-made duos (your own duos come in a later release).

• libraryKeystringrequired

  From GET /duos/library.

EmbedToken

• tokenstringrequired

  Five minutes, single use.

• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

• urlstringrequired

  Opens the portal as that person (a full page).

• embedUrlstringrequired

  What an iframe mounts (zentiq-embed.js, @zentiq/react's <ZentiqPortal>).

EmbedTokenInput

• 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

Error

• errorobjectrequired
  • codestring (one of 33)required

    What went wrong, from the error catalogue.

  • messagestringrequired

    Plain English, safe to show an admin.

  • paramstring

    The input at fault, as a path: body.faqs[3].a, query.limit, params.id.

  • detailsmap of any

    Structured extras: a plan refusal's feature and plan (and reason: plan_required when the plan is why a feature's switch is off), a conflict's reason, go-live problems, the current version.

Escalation

• idstringrequired

  Escalation id (esc_…).

  pattern `^esc_.*`

• urlstringrequired

  The link to show the customer (or open in the widget). It works once, for 30 minutes; the token is in its fragment, never sent to a server.

• tokenstringrequired

  zesc_…: the link's own token (already in url). For one conversation only; never put it in a query string or a log.

• expiresAtstring (date-time)required

  ISO 8601 UTC timestamp.

EscalationCompletedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• escalationIdstring | null
• portalIdstring | null
• source"api" | "intercom" | "zendesk" | "widget" | null
• externalRefstring | null
• customerRefstring | null
• status"completed" | "abandoned" | null
• minutesnumber | null
• secondsnumber | null
• turnsHandedOverinteger | null
• referencestring | null
• startedAtstring | null
• endedAtstring | null
• outcome"resolved" | "handoff" | "booking" | "lead" | "unresolved" | "no_conversation" | null
• resolvedboolean | null
• summarystring | null

EscalationInput

• 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

Event

• idstringrequired

  evt_…: the webhook envelope's id, the same on every delivery.

  pattern `^evt_.*`

• typestringrequired
• apiVersion"2026-07-08" | "2026-10-01"

  From 2026-10-01: the contract data is written in.

• organizationIdstring

  From 2026-10-01.

  pattern `^org_.*`

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• datamap of anyrequired

  Exactly what a webhook with this key's rights receives (the event type's data schema; see GET /v1/event-types).

• aiGeneratedtrue

  Present, and true, when data carries words an avatar wrote: a summary, a report or an avatar's turn (EU AI Act Article 50(2)). Every contract.

EventType

• typestringrequired
• descriptionstringrequired
• since"2026-07-08" | "2026-10-01"required

  The contract it appeared in.

• explicitOnlybooleanrequired

  Never part of "*": a webhook receives it only by naming it.

• requiresConversationbooleanrequired

  Only for a webhook with includeConversation.

• fieldsobjectrequired

  data's fields by class (a.b, [] a list's items): contact only on leads, bookings and hand-offs; result only for released results; conversation only with includeConversation, where allowed.

  • structurestring[]required
  • contactstring[]required
  • resultstring[]required
  • conversationstring[]required
• dataSchemamap of anyrequired

  data's JSON Schema in the current contract.

GoLiveProblem

• fieldstringrequired

  Where it is in the content document (faqs, screening.requirements[1], facts); setup for the set-up as a whole.

• messagestringrequired
• shortstringrequired

  A few words for a list.

GuardianConsentInput

• by"organisation" | "guardian" | "teacher"required

  Who gave it: the organisation attests, a guardian gave it, a teacher recorded it on file.

• guardianEmailstring (email) | null

  Kept on the place as evidence; never sent in any event or webhook.

• methodstringrequired

  How it was given: school_form, in_person, email, …

  1-40 characters

• evidenceRefstring | null

  Your own reference to the evidence.

HandoffJoinedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• portalIdstring | null
• staffUserIdstring | null
• via"console" | "email" | "api" | null
• staffCountinteger | null

HandoffLeftData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• portalIdstring | null
• staffUserIdstring | null
• secondsinteger | null
• next"stayed" | "resumed" | "ended" | null

HandoffRequestedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• summarystring | null
• needstring | null
• budgetstring | null
• timelinestring | null
• contactobject | null
  • namestring | null
  • emailstring | null
  • phonestring | null
  • companystring | null
  • rolestring | null
  • preferredTimestring | null
  • locationstring | null
  • referencestring | null
• consentobject | null
  • purposestring | null
  • marketingboolean | null
  • textstring | null
  • versioninteger | null
  • atstring | null
  • givenboolean | null
• promisestring | null
• dueAtstring | null
• departmentstring | null
• verifiedboolean | null
• portalIdstring | null
• reasonstring | null
• intentstring | null
• inboxItemIdstring | null

HandoffUpdatedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• summarystring | null
• needstring | null
• budgetstring | null
• timelinestring | null
• contactobject | null
  • namestring | null
  • emailstring | null
  • phonestring | null
  • companystring | null
  • rolestring | null
  • preferredTimestring | null
  • locationstring | null
  • referencestring | null
• consentobject | null
  • purposestring | null
  • marketingboolean | null
  • textstring | null
  • versioninteger | null
  • atstring | null
  • givenboolean | null
• promisestring | null
• dueAtstring | null
• departmentstring | null
• verifiedboolean | null
• portalIdstring | null
• reasonstring | null
• intentstring | null
• inboxItemIdstring | null

Health

• status"ok"required
• version"v1"required

InboxItem

• idstringrequired

  inb_…: the visitor's conversation (webhooks' inboxItemId).

  pattern `^inb_.*`

• sessionIdstringrequired

  Session id (sess_…).

  pattern `^sess_.*`

• portalIdstring | nullrequired

  The portal the visitor came through, when known.

• subjectIdstring | nullrequired
• subjectstring | nullrequired

  The subject's name when the request came in.

• referencestring | nullrequired

  The reference the visitor was given.

• receivedAtstring (date-time)required

  When the conversation's first request came in.

• kinds("lead" | "booking" | "handoff")[]required
• primary"lead" | "booking" | "handoff"required

  What the item is mainly about: a booking, else a lead, else a hand-off.

• status"new" | "contacted" | "confirmed" | "closed"required
• statusAtstring (date-time) | nullrequired
• statusByobject | nullrequired

  Who moved it last: a member, or an API key (yours included, so a sync can ignore its own changes).

  • type"user" | "api_key"required
  • idstringrequired

    usr_… or key_….

• notestring | nullrequired

  The team's note with the latest status.

• overduebooleanrequired
• dueAtstring (date-time) | nullrequired

  When the visitor was promised an answer by.

• promisestring | nullrequired

  What the visitor was told about when they would hear back.

• contactobject | nullrequired

  The details the visitor gave, with their consent, for this request; payment and identity numbers are masked. Never an under-18's.

  • namestring | nullrequired
  • emailstring | nullrequired
  • phonestring | nullrequired
  • companystring | nullrequired
  • rolestring | nullrequired
  • locationstring | nullrequired
  • preferredTimestring | nullrequired
  • referencestring | nullrequired
• teamstring | nullrequired

  The team it went to.

• leadobject | nullrequired
  • bandstring | nullrequired
  • pointsnumber | nullrequired
• bookingobject | nullrequired

  A booking request: nothing is in a calendar until someone confirms it with the visitor.

  • servicestring | nullrequired
  • whenstring | nullrequired
• consentobject | nullrequired

  What the visitor agreed to: to be contacted about this request, never marketing.

  • purposestring | nullrequired
  • marketingfalserequired
  • versioninteger | nullrequired
  • atstring (date-time) | nullrequired
  • givenboolean | nullrequired
• verifiedboolean | nullrequired

  false: some of the request was read only from the visitor's page (it could be made up); null: recorded before Zentiq checked.

• removedFieldsstring[]required

  Details the visitor had removed; delete them from your records too.

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

• needstring | null

  What they need, in their words. Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

• budgetstring | null

  Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

• timelinestring | null

  Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

• summarystring | null

  The conversation's summary. Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

• reasonstring | null

  Why they asked for a person. Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

• answersmap of string | null

  A lead's answers to the qualification questions. Only for a key holding transcripts:read, and never from an under-18's, a candidate's or a safety-flagged conversation (absent otherwise).

InboxItemUpdate

• status"new" | "contacted" | "confirmed" | "closed"required
• notestring

  The team's note with the new status (at most 500 characters).

  at most 500 characters

• expectedStatus"new" | "contacted" | "confirmed" | "closed"

  The status you last saw: when it has changed since, nothing changes (409 conflict, details.currentStatus).

InboxMoveData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• requeststring | null
• statusstring | null
• previousstring | null
• byobject | null
  • type"user" | "api_key" | null
  • idstring | null

Invite

• idstringrequired

  Invite id (inv_…).

  pattern `^inv_.*`

• roleIdstringrequired

  Subject id (sub_…).

• portalIdstring | nullrequired

  The portal whose door the link opens.

• externalIdstring | nullrequired

  Your ATS's own id for the applicant, sent back on every candidate event.

• metadatamap of stringrequired
• namestring | nullrequired

  Null once the candidate's data was erased.

• emailstring | nullrequired
• phonestring | nullrequired
• status"invited" | "opened" | "started" | "completed" | "cancelled" | "expired"required

  invited → opened → started → completed; or cancelled (by the team, rescheduled, or a missed set time) or expired (a passed deadline).

• cancelReason"late" | "withdrawn_by_team" | "rescheduled" | nullrequired
• timing"open" | "deadline" | "scheduled"required
• startAtstring (date-time) | nullrequired

  scheduled: the interview time.

• opensAtstring (date-time) | nullrequired

  scheduled: when the link opens.

• lateAtstring (date-time) | nullrequired

  scheduled: not started by then, the invite is cancelled as late.

• deadlineAtstring (date-time) | nullrequired

  deadline: the interview must be started by then.

• sentAtstring (date-time) | nullrequired

  When Zentiq last emailed it; null when the link was only copied.

• openedAtstring (date-time) | nullrequired
• startedAtstring (date-time) | nullrequired
• completedAtstring (date-time) | nullrequired
• cancelledAtstring (date-time) | nullrequired
• candidateIdstring | nullrequired

  The candidate (cand_…) once their interview reached the hiring team.

• linkstring | nullrequired

  The candidate's personal link while it can be used: a secret, give it only to them.

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

InviteTiming

• mode"scheduled"required
• deadlineAtstring (date-time)

  30 minutes to 90 days from now.

• startAtstring (date-time)

  In the future, within 90 days.

• earlyMinutesinteger

  scheduled: how early the link opens (default 10).

  0-120

• lateMinutesinteger

  scheduled: how late a start may be before the invite is cancelled (default 15).

  1-120

JobCompletedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• jobIdstring | null
• typestring | null
• statusstring | null
• subjectIdsstring[] | null

KeyInput

• namestring

  Up to 60 characters. Default "API key".

• scopesstring[]

  Scope names, or ["*"] (the default, [] means the same) for full access. A key can only give scopes it holds itself.

  at most 64 items

• apiVersion"2026-07-08" | "2026-10-01"

  The contract the new key speaks. Default: the contract of this request.

KeyList

Type: ApiKey[]

KeyRevoked

• revokedtruerequired
• idstringrequired

  API key id (key_…).

  pattern `^key_.*`

KeyWithSecret

• idstringrequired

  API key id (key_…).

  pattern `^key_.*`

• namestringrequired
• prefixstringrequired

  The key's first characters, as shown in the console.

• scopesstring[]required

  The scopes as set on the key; [] or ["*"] is full access (sensitive scopes are added by name).

• apiVersion"2026-07-08" | "2026-10-01"required

  The contract the key speaks.

• createdBystring | nullrequired

  Who made it: a member (usr_…) or a key (key_…); null for older keys.

• lastUsedAtstring (date-time) | nullrequired
• revokedAtstring (date-time) | nullrequired
• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• keystringrequired

  The full key. Returned once: store it now.

KnowledgeBase

• idstringrequired

  Knowledge base id (kb_…).

  pattern `^kb_.*`

• namestringrequired
• documentCountintegerrequired

  Its documents (not deleted ones).

• readyCountintegerrequired

  Its documents that have been read: the ones the avatar answers from.

• createdAtstring (date-time)required

  ISO 8601 UTC timestamp.

• updatedAtstring (date-time)required

  ISO 8601 UTC timestamp.

KnowledgeBaseInput

• namestringrequired

  at most 200 characters

KnowledgeDocumentFailedData

• documentIdstring | null
• knowledgeBaseIdstring | null
• error"The document could not be read. Check that it is a readable PDF, Word, text, Markdown or CSV file." | "No text was found in the document. If it is a scan or a picture, upload a version with text you can select." | "Processing the document took too long. Try a smaller file." | "Document processing is unavailable right now. Try again later." | "The document could not be processed." | null
• errorCode"unreadable" | "empty" | "timeout" | "unavailable" | "failed" | null

KnowledgeDocumentProcessedData

• documentIdstring | null
• knowledgeBaseIdstring | null
• chunkCountinteger | null

KnowledgeGapData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• sourcestring | null
• referencestring | null
• questionsstring[] | null

Language

• codestringrequired

  BCP-47 code: what the API takes and returns.

• namestringrequired

  English name.

• nativeNamestringrequired

  Its own name.

• duobooleanrequired

  A duo (two people in one conversation) speaks it: ten languages do.

• duoNamestring | nullrequired

  How a duo shows it (a duo has one Portuguese); null when a duo doesn't speak it.

• betabooleanrequired

  Offered to one avatar in beta (Cantonese).

Languages

• languagesLanguage[]required

  Every language an avatar speaks, from the catalogue: one avatar any of them, a duo the ten flagged duo.

• enginesobjectrequired

  The two voice engines.

  • premierVoiceEnginerequired

    A voice engine. The voice decides which one a persona runs on: see Voice.engine.

  • globalVoiceEnginerequired

    A voice engine. The voice decides which one a persona runs on: see Voice.engine.

• accentsobject[]required

  Values for settings.accent that speak English with the accent of another language.

  • keystringrequired
  • labelstringrequired

LeadCapturedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• workspaceNamestring | null
• referencestring | null
• summarystring | null
• needstring | null
• budgetstring | null
• timelinestring | null
• contactobject | null
  • namestring | null
  • emailstring | null
  • phonestring | null
  • companystring | null
  • rolestring | null
  • preferredTimestring | null
  • locationstring | null
  • referencestring | null
• consentobject | null
  • purposestring | null
  • marketingboolean | null
  • textstring | null
  • versioninteger | null
  • atstring | null
  • givenboolean | null
• promisestring | null
• dueAtstring | null
• departmentstring | null
• verifiedboolean | null
• portalIdstring | null
• leadBandstring | null
• pointsnumber | null
• answersmap of string | null
• inboxItemIdstring | null

LearnerSignedInData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• methodstring | null
• portalIdstring | null

LibraryDuo

• keystringrequired

  What POST /duos takes as libraryKey.

• titlestringrequired
• scenariostring | nullrequired
• peopleobject[]required

  The person on the left, then the one on the right.

  • namestringrequired
  • gender"female" | "male"required
  • rolestring | nullrequired

    Their part in the conversation, in a few words.

• relationshipstring | nullrequired

  couple, colleagues, family or panel.

• previewUrlstringrequired

  Their picture (public).

• aiGeneratedtruerequired

  Always true: the duo's video and voices are AI-generated, and so is their picture unless it is a photo you uploaded (EU AI Act Article 50(2)).

LoginCard

• usernamestringrequired
• orgCodestringrequired
• pinstringrequired

  Shown once, never again: print or hand it over now.

MasteryUpdatedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• skillstring | null
• topicstring | null
• beforenumber | null
• afternumber | null
• confidencenumber | null

Me

• organizationobjectrequired
  • idstringrequired

    Organisation id (org_…).

    pattern `^org_.*`

  • displayNamestringrequired

    The name the organisation chose for the API (never an internal workspace name).

  • planstringrequired

    The plan's code (free, starter, plus, pro, business, enterprise).

  • createdAtstring (date-time)required

    ISO 8601 UTC timestamp.

• planobjectrequired
  • keystringrequired
  • namestringrequired
  • includedMinutesnumber | nullrequired

    The plan's minutes this cycle; null on an unlimited account.

  • featuresstring[]required

    The plan's features that are on (dashboards.serve, embed.website, api.access, …).

• limitsobjectrequired
  • maxConcurrentSessionsinteger | nullrequired

    Live sessions at once; null = no limit.

  • activeSessionsintegerrequired
  • minutesRemainingnumber | nullrequired

    Minutes the account can still spend (and within its own monthly API cap); null = unlimited.

• rateLimitsobjectrequired

  The rate limits this key works within (RateLimit-* headers on every answer).

  • windowSecondsintegerrequired
  • perKeyobjectrequired

    Requests per window, by operation class (each operation's class is in the reference as x-zentiq-rate-class).

    • readintegerrequired
    • writeintegerrequired
    • liveintegerrequired
    • heavyintegerrequired
    • searchintegerrequired
  • perOrganizationobjectrequired

    Shared by all of the organisation's keys.

    • readintegerrequired
    • writeintegerrequired
    • liveintegerrequired
    • heavyintegerrequired
    • searchintegerrequired
• apiKeyobjectrequired
  • idstringrequired

    API key id (key_…).

    pattern `^key_.*`

  • namestring | nullrequired
  • prefixstringrequired

    The key's first characters, as shown in the console.

  • scopesstring[]required

    The key's scopes as set on it; [] or ["*"] is full access.

  • effectiveScopesstring[]required

    Every scope the key holds, after full access and the implied scopes of keys made before 2026-10-01.

  • fullAccessbooleanrequired
  • apiVersion"2026-07-08" | "2026-10-01"required

    The contract the key is pinned to (Zentiq-Version may ask for a newer one).

  • lastUsedAtstring (date-time) | nullrequired
  • createdAtstring (date-time)required

    ISO 8601 UTC timestamp.

MemberAddedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• rolestring | null
• methodstring | null
• gradeBandstring | null
• statusstring | null

MemberRemovedData

• eventIdstring | null
• organizationIdstring | null
• workspaceIdstring | null
• unitIdstring | null
• userIdstring | null
• sessionIdstring | null
• blueprintVersioninteger | null
• rolestring | null
• scopestring | null
• rolesstring[] | null
• teamsstring[] | null
• accountDeactivatedboolean | null