Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.
ROPA (Record of Processing Activities) und DPIA (Data
Protection Impact Assessment) sind die Selbst-Dokumentationsseite der
DSGVO. Wo ein DSAR das what
Datenobjekt anfragt covers, deckt das Register das, was Ihre
Organisation über sich selbst aufschreiben muss — bevor eine Anfrage
eintrifft.
Diese Seite beschreibt Orbits Plattformkontrollen. Sie ist keine
Rechtsberatung. Ob Sie ein Controller oder Processor sind, welche
Aktivitäten hochriskant sind und was Ihr Register enthalten muss,
hängt von Ihrer Verarbeitung ab. Bestätigen Sie mit qualifiziertem
Rechtsbeistand.
Alle Endpunkte unten sind ge-rooted auf
https://api.orbit.devotel.io/api/v1/compliance.
DSGVO Art. 30 verlangt, dass jeder Controller (und jeder Processor)
ein Protokoll seiner Verarbeitungsaktivitäten hält. Für jede Aktivität
namen das Protokoll den Zweck, die Kategorien von Datenobjekten
und Daten, die Empfänger, jede Cross-Border-Transfers und
ihre Schutz, die Aufbewahrungsdauer und die Sicherheitsmaßnahmen.
Ein Aufsichtsbehörde kann das Protokoll auf Anfrage für Art. 30(4)
verlangen.DSGVO Art. 35 verlangt eine DPIA vor Verarbeitung, die
wahrscheinlich hochriskant ist — automated decision-making mit
wesentlichen Effekten, groß-scale Verarbeitung von special-category-
Daten oder systematic Monitoring öffentlich zugänglicher Gebiete. Die
Assessment-Records necessity und proportionality, die Risiken
identifiziert, die mitigations, das Residual-Risiko und das Ergebnis.Orbit screens jede Aktivität, die Sie eingeben, gegen die Art. 35(3)-
Trigger und flaggt, ob eine DPIA erforderlich ist — und blockiert die
Aktivierung einer flagged-Aktivität, bis die DPIA aufgezeichnet ist
(siehe Status-Lebenszyklus).
Das Register ist Ihres — Orbit hält es, es nie füllt es
Das Register dokumentiert Ihre Organisations-
Verarbeitung. Orbit liefert den Speicher, den Status-Lebenszyklus,
das DPIA Screening und den Audit-ready-Export — es nie entscheidet,
was Ihre Rechtsgrundgrund ist oder was Ihre Aufbewahrungsdauer sein
sollte. Jede Aktivität wird erstellt, weitergeführt und assessed von
Ihrem eigenen Team, zu wie Regulatoren Art. 30 lesen: das Register
muss die Controller-eigene Kenntnis widerspiegeln.Jede Aktivität erhält bei Eingabe eine menschliche Referenz (zum
Beispiel ROPA-2026-0004), sodass Sie sie in Ihren internen
Policies und in Korrespondenz mit einer Behörde zitieren können.
Eine Aktivität durchläuft:draft → active → under_review → retiredPATCH /compliance/processing-activities/{id} aktualisiert mutable
Felder und/oder rückt den Status vor:
Eine Aktivität, deren Screening eine DPIA-Anforderung flagged, wird
mit 409 Conflict abgelehnt, bis eine DPIA aufgezeichnet wurde, deren
Ergebnis nicht do_not_proceed ist. Das macht das Register präventiv —
hochriskante Verarbeitung kann nicht unprotokolliert gehen.
GET /compliance/processing-activities — das ganze Register plus
einen Zusammenfassung: Zählungen nach Status, wie viele Aktivitäten
der Screen als DPIA-required flaggt (dpiaRequired), wie viele
davon noch keine aufgezeichnete DPIA haben (dpiaMissing) und wie
viele aufgezeichnete DPIAs auf einen high-Residual-Risiko fielen
(highResidualRisk).
GET /compliance/processing-activities/{id} — eine Aktivität mit
ihrem Screening und, sobald aufgezeichnet, ihrer DPIA.
PUT /compliance/processing-activities/{id}/dpia — braucht ein Admin-
oder Owner-API-Key. Zeichnet (oder ersetzt) die Art. 35-Assessment
für die Aktivität.
curl -X PUT https://api.orbit.devotel.io/api/v1/compliance/processing-activities/processingActivity_7kf2…/dpia \ -H "X-API-Key: dv_live_sk_..." \ -H "Content-Type: application/json" \ -d '{ "necessity_proportionality": "Anrufaufzeichnung ist auf Support-Linien begrenzt; Aufbewahrung ist auf 90 Tage gecapt; Zugang ist auf das Support-Ops-Team eingeschränkt.", "risks_identified": ["Unauthorisiertes Zugang zu Aufzeichnungen", "Aufbewahrung jenseits des angegebenen Zwecks"], "likelihood": "medium", "severity": "high", "mitigations": ["Roll-restricted Zugang", "Automatisierte Löschung bei 90 Tagen", "Zugangs-Audit-Trail"], "residual_risk": "medium", "dpo_consulted": true, "outcome": "proceed_with_safeguards" }'
Feld
Typ
Notizen
necessity_proportionality
string
Erforderlich. Art. 35(7)(b).
risks_identified
string[]
Risiken für die Rechte und Freiheiten von Datenobjekten.
likelihood
enum
Erforderlich.low, medium, high.
severity
enum
Erforderlich.low, medium, high.
mitigations
string[]
Art. 35(7)(d) — Maßnahmen, die envisagitiert, um die Risiken zu adressieren.
residual_risk
enum
Risiko verbleibend nach mitigations. Defaults auf die Likelihood × Severity Matrix-Rating, wenn omittt.
dpo_consulted
boolean
Art. 35(2).
outcome
enum
Art. 35(7)(d)-Entscheid: proceed, proceed_with_safeguards, consult_authority, do_not_proceed. Defaults auf proceed_with_safeguards.
consult_authority mapped auf die Art. 36-Prior-Consultation-Pflicht,
geschuldet wenn ein high-Residual-Risiko nicht mitigiert werden kann.
Ein Ergebnis von do_not_proceed blockiert die Aktivierung der
Aktivität — lassen Sie es nur, wenn die Assessment schließlich
schließt, dass die Verarbeitung rechtmäßig nicht gehen kann.Jede DPIA zeichnet, wer assessed und wann (assessedAt, assessedBy).
GET /compliance/processing-activities/inventory gibt das ganze
Register serialisiert in der Audit-ready-Form zurück — das Attachment,
das ein DPO einem Aufsichtsbehörde auf einer Art. 30(4)-Anfrage
übergibt oder an einen Auditor-Evidence-Request attached.
Jedes Datensatz trägt seinen DPIA-Zustand — dpiaRequired,
dpiaRecorded, dpiaOutcome, residualRisk — sodass das Inventar
sich als Evidenz verdoppelt, dass hochriskante Verarbeitung gescreent
und assessed wurde.
Reads (GET) sind für jedes authentifizierte Mitglied Ihrer
Organisation offen. Writes (POST, PATCH, PUT …/dpia) sind
Ernst auf Owner und Admin-Rollen — das Register ist ein
regulatorisches Kontrolle, in Einklang mit dem Rest der
Compliance-Schreibfläche (Breach-Incidents, Aufbewahrungs-Policy).
Jedes Intake, Update und DPIA-Aufzeichnung ist in Ihrem Audit-Log
mit dem Actor, der Aktivitäts-Referenz und dem Ergebnis geschrieben.
Datenobjekt-Zugangs-Anfragen (DSAR) — die andere
Hälfte von DSGVO: das Empfangen, Verifizieren und Erfüllen von
Subject-Access-, Erasure- und Portability-Anfragen über DSGVO,
CCPA/CPRA, LGPD, PDPA und DPDP.
Consent Management — aufzeichnen
und aussehen den Consent-Zustand, den eine Aktivität als ihre
Rechtsgrundlage anrufen kann.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Devotel Orbit Documentation","colors":{"primary":"#325FEC","light":"#6E8BF2","dark":"#1E3FB0"},"logo":{"light":"https://mintcdn.com/zeelaltd/MGUsS3FF5JAMebgK/logo/light.svg?fit=max\u0026auto=format\u0026n=MGUsS3FF5JAMebgK\u0026q=85\u0026s=379027fc60301d5269699b31297af81f","dark":"https://mintcdn.com/zeelaltd/MGUsS3FF5JAMebgK/logo/dark.svg?fit=max\u0026auto=format\u0026n=MGUsS3FF5JAMebgK\u0026q=85\u0026s=67a70e8b7c67a32ef24574aa908f98ae"},"favicon":"https://mintcdn.com/zeelaltd/MGUsS3FF5JAMebgK/favicon.svg?fit=max\u0026auto=format\u0026n=MGUsS3FF5JAMebgK\u0026q=85\u0026s=d92b46f00c590bc9435ef6eb4504b678","api":{"openapi":["openapi.yaml"],"mdx":{"server":"https://api.orbit.devotel.io"}},"navbar":{"links":[{"href":"https://orbit.devotel.io","label":"Dashboard"},{"href":"https://status.orbit.devotel.io","label":"Status"},{"href":"https://orbit.devotel.io/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Sign Up","href":"https://orbit.devotel.io/en/signup"}},"footer":{"socials":{"twitter":"https://twitter.com/devotel","github":"https://github.com/devotel","linkedin":"https://www.linkedin.com/company/devotel"}},"search":{"prompt":"Search Orbit docs"},"seo":{"metatags":{"canonical":"https://docs.orbit.devotel.io"},"indexing":"all"},"integrations":{"posthog":{"apiKey":"phc_XtdzTPv9Crueb9iavWKvJv1W2ctvKVt4EMHHQJ01o57","apiHost":"https://us.i.posthog.com"}},"errors":{"404":{"redirect":false}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeelaltd","hasAudioNarration":false,"actualSubdomain":"zeelaltd","customDomains":["docs.orbit.devotel.io"],"gitSource":{"type":"github","owner":"dddfedddddd","repo":"devotel-cpaas","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae7aa9c25d97c0814f4062b","collectionId":"8357bf7c-17e4-4e80-b8f7-3687c8742d5e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae7aa9c25d97c0814f4062b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7aa9c25d97c0814f4062b","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":4524},{"language":"default","tag":"All Endpoints","count":4156},{"language":"default","tag":"Guides","count":1553},{"language":"default","tag":"Documentation","count":846},{"language":"default","tag":"Voice","count":575},{"language":"default","tag":"Reference","count":510},{"language":"default","tag":"Compliance","count":498},{"language":"default","tag":"Concepts","count":380},{"language":"default","tag":"Agents","count":328},{"language":"default","tag":"CDP","count":316}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"de/compliance/privacy-register","slug":"/de/compliance/privacy-register","pageMetadata":{"title":"DSGVO-Verarbeitungsregister (ROPA + DPIA)","description":"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.","href":"/de/compliance/privacy-register"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`dsgvo-verarbeitungsregister-ropa-+-dpia`,children:`DSGVO-Verarbeitungsregister (ROPA + DPIA)`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`ROPA`}),` (Record of Processing Activities) und `,_jsx(_components.strong,{children:`DPIA`}),` (Data\nProtection Impact Assessment) sind die Selbst-Dokumentationsseite der\nDSGVO. Wo ein DSAR das what\nDatenobjekt anfragt covers, deckt das Register das, was Ihre\nOrganisation über sich selbst aufschreiben muss — bevor eine Anfrage\neintrifft.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Diese Seite beschreibt Orbits Plattformkontrollen. Sie ist `,_jsx(_components.strong,{children:`keine\nRechtsberatung.`}),` Ob Sie ein Controller oder Processor sind, welche\nAktivitäten hochriskant sind und was Ihr Register enthalten muss,\nhängt von Ihrer Verarbeitung ab. Bestätigen Sie mit qualifiziertem\nRechtsbeistand.`]})}),`\n`,_jsxs(_components.p,{children:[`Alle Endpunkte unten sind ge-rooted auf\n`,_jsx(_components.code,{children:`https://api.orbit.devotel.io/api/v1/compliance`}),`.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`was-art-30-und-art-35-verlangen`,children:`Was Art. 30 und Art. 35 verlangen`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`DSGVO Art. 30`}),` verlangt, dass jeder Controller (und jeder Processor)\nein Protokoll seiner Verarbeitungsaktivitäten hält. Für jede Aktivität\nnamen das Protokoll den `,_jsx(_components.strong,{children:`Zweck`}),`, die `,_jsx(_components.strong,{children:`Kategorien von Datenobjekten\nund Daten`}),`, die `,_jsx(_components.strong,{children:`Empfänger`}),`, jede `,_jsx(_components.strong,{children:`Cross-Border-Transfers und\nihre Schutz`}),`, die `,_jsx(_components.strong,{children:`Aufbewahrungsdauer`}),` und die `,_jsx(_components.strong,{children:`Sicherheitsmaßnahmen`}),`.\nEin Aufsichtsbehörde kann das Protokoll auf Anfrage für Art. 30(4)\nverlangen.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`DSGVO Art. 35`}),` verlangt eine `,_jsx(_components.strong,{children:`DPIA`}),` vor Verarbeitung, die\nwahrscheinlich hochriskant ist — automated decision-making mit\nwesentlichen Effekten, groß-scale Verarbeitung von special-category-\nDaten oder systematic Monitoring öffentlich zugänglicher Gebiete. Die\nAssessment-Records necessity und proportionality, die Risiken\nidentifiziert, die mitigations, das Residual-Risiko und das Ergebnis.`]}),`\n`,_jsxs(_components.p,{children:[`Orbit screens jede Aktivität, die Sie eingeben, gegen die Art. 35(3)-\nTrigger und flaggt, ob eine DPIA erforderlich ist — und blockiert die\nAktivierung einer flagged-Aktivität, bis die DPIA aufgezeichnet ist\n(siehe `,_jsx(_components.a,{href:`#status-lifecycle`,children:`Status-Lebenszyklus`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`das-register-ist-ihres-—-orbit-hält-es-es-nie-füllt-es`,children:`Das Register ist Ihres — Orbit hält es, es nie füllt es`}),`\n`,_jsxs(_components.p,{children:[`Das Register dokumentiert `,_jsx(_components.strong,{children:`Ihre`}),` Organisations-\nVerarbeitung. Orbit liefert den Speicher, den Status-Lebenszyklus,\ndas DPIA Screening und den Audit-ready-Export — es nie entscheidet,\nwas Ihre Rechtsgrundgrund ist oder was Ihre Aufbewahrungsdauer sein\nsollte. Jede Aktivität wird erstellt, weitergeführt und assessed von\nIhrem eigenen Team, zu wie Regulatoren Art. 30 lesen: das Register\nmuss die Controller-eigene Kenntnis widerspiegeln.`]}),`\n`,_jsxs(_components.p,{children:[`Jede Aktivität erhält bei Eingabe eine menschliche Referenz (zum\nBeispiel `,_jsx(_components.code,{children:`ROPA-2026-0004`}),`), sodass Sie sie in Ihren internen\nPolicies und in Korrespondenz mit einer Behörde zitieren können.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`verarbeitungsaktivitäten-aufzeichnen`,children:`Verarbeitungsaktivitäten aufzeichnen`}),`\n`,_jsx(Heading,{level:`3`,id:`eine-aktivität-erstellen`,children:`Eine Aktivität erstellen`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /compliance/processing-activities`}),` — braucht ein Admin- oder\nOwner-API-Key. Die Aktivität landet im Status `,_jsx(_components.code,{children:`draft`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`20`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.orbit.devotel.io/api/v1/compliance/processing-activities`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: dv_live_sk_...\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Kundensupport-Anrufaufzeichnungen\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"description\": \"Sprachaufzeichnungen eingehender Support-Anrufe, genutzt für Qualitätsreview und Streitbeilegung.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"purpose\": \"Qualitätssicherung und Streitbeilegung für Support-Interaktionen.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"controller_role\": \"controller\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"lawful_basis\": \"legitimate_interests\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data_subject_categories\": [\"Kunden\", \"Prospects\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data_categories\": [\"Audioaufzeichnungen\", \"Anrufernummer\", \"Agent-Notizen\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"special_categories\": [],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"recipients\": [\"Support-Ops-Team\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"cross_border_transfers\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"retention_period\": \"90 Tage nach Anruf, dann gelöscht\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"security_measures\": [\"Verschlüsselung aufhalt\", \"Roll-restricted Zugang\", \"Audit Logging\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"large_scale\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"automated_decision_making\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"systematic_monitoring\": false`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Gibt `,_jsx(_components.code,{children:`201 Created`}),` mit der Aktivität und einem `,_jsx(_components.code,{children:`screening`}),`-Block zurück:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"processingActivity_7kf2…\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ROPA-2026-0004\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"draft\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"screening\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"required\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"triggers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Feld`}),_jsx(_components.th,{children:`Typ`}),_jsx(_components.th,{children:`Notizen`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` 2–200 Zeichen.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`description`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` 2–8000 Zeichen.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`purpose`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` Art. 30(1)(b).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`controller_role`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`controller`}),` (default), `,_jsx(_components.code,{children:`joint_controller`}),`, `,_jsx(_components.code,{children:`processor`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`lawful_basis`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` Eines von `,_jsx(_components.code,{children:`consent`}),`, `,_jsx(_components.code,{children:`contract`}),`, `,_jsx(_components.code,{children:`legal_obligation`}),`, `,_jsx(_components.code,{children:`vital_interests`}),`, `,_jsx(_components.code,{children:`public_task`}),`, `,_jsx(_components.code,{children:`legitimate_interests`}),` (DSGVO Art. 6(1)).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data_subject_categories`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 30(1)(c) — über wen die Daten sind.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data_categories`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 30(1)(c) — was die Daten sind.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`special_categories`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 9 special categories present — ihre Präsenz nährt den DPIA-Screen.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`recipients`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 30(1)(d) — Kategorien von Empfängern.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cross_border_transfers`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Art. 30(1)(e) — Transfers außerhalb des EEA.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transfer_safeguard`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Der Art. 44–50 Schutz, auf den verlassen wird (SCCs, adequacy, BCRs…).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`retention_period`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Art. 30(1)(f) — Freitext-Policy-Referenz.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`security_measures`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 30(1)(g) / Art. 32 technische und organisatorische Maßnahmen.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`large_scale`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Nährt den Art. 35-Screen.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`automated_decision_making`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Art. 35(3)(a)-Trigger.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`systematic_monitoring`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Art. 35(3)(c)-Trigger.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`das-dpia-screening`,children:`Das DPIA-Screening`}),`\n`,_jsxs(_components.p,{children:[`Jedes `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`PATCH`}),` und `,_jsx(_components.code,{children:`PUT …/dpia`}),` Antwort enthält einen\n`,_jsx(_components.code,{children:`screening`}),`-Block. Es flagged die Art. 35(3)-Trigger deterministisch:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`automated_decision_making: true`}),` → automated decision-making mit\nrechtlichen oder ähnlich signifikanten Effekten (Art. 35(3)(a)).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`systematic_monitoring: true`}),` → systematic Monitoring eines\nöffentlich zugänglichen Bereichs (Art. 35(3)(c)).`]}),`\n`,_jsxs(_components.li,{children:[`Non-empty `,_jsx(_components.code,{children:`special_categories`}),` zusammen mit `,_jsx(_components.code,{children:`large_scale: true`}),` →\ngroß-scale Verarbeitung von special categories (Art. 35(3)(b)).`]}),`\n`,_jsx(_components.li,{children:`Ein Alleine-Vorkommen eines special-category- oder large-scale-Flags\nerscheint trotzdem als ein High-Risk-Indicator (Art. 9 /\nArt. 35(1)).`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`screening.required: true`}),` bedeutet, dass eine DPIA aufgezeichnet\nwerden muss, bevor die Aktivität zu `,_jsx(_components.code,{children:`active`}),` bewegen kann.`]}),`\n`,_jsx(Heading,{level:`3`,id:`status-lebenszyklus`,children:`Status-Lebenszyklus`}),`\n`,_jsx(_components.p,{children:`Eine Aktivität durchläuft:`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`draft`}),` → `,_jsx(_components.code,{children:`active`}),` → `,_jsx(_components.code,{children:`under_review`}),` → `,_jsx(_components.code,{children:`retired`})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`PATCH /compliance/processing-activities/{id}`}),` aktualisiert mutable\nFelder und/oder rückt den Status vor:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PATCH`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.orbit.devotel.io/api/v1/compliance/processing-activities/processingActivity_7kf2…`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: dv_live_sk_...\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"status\": \"active\" }'`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Eine Aktivität, deren Screening eine DPIA-Anforderung flagged, wird\nmit `,_jsx(_components.code,{children:`409 Conflict`}),` abgelehnt, bis eine DPIA aufgezeichnet wurde, deren\nErgebnis nicht `,_jsx(_components.code,{children:`do_not_proceed`}),` ist. Das macht das Register präventiv —\nhochriskante Verarbeitung kann nicht unprotokolliert gehen.`]}),`\n`,_jsx(Heading,{level:`3`,id:`das-register-lesen`,children:`Das Register lesen`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET /compliance/processing-activities`}),` — das ganze Register plus\neinen Zusammenfassung: Zählungen nach Status, wie viele Aktivitäten\nder Screen als DPIA-required flaggt (`,_jsx(_components.code,{children:`dpiaRequired`}),`), wie viele\ndavon noch keine aufgezeichnete DPIA haben (`,_jsx(_components.code,{children:`dpiaMissing`}),`) und wie\nviele aufgezeichnete DPIAs auf einen high-Residual-Risiko fielen\n(`,_jsx(_components.code,{children:`highResidualRisk`}),`).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET /compliance/processing-activities/{id}`}),` — eine Aktivität mit\nihrem Screening und, sobald aufgezeichnet, ihrer DPIA.`]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`eine-dpia-aufzeichnen`,children:`Eine DPIA aufzeichnen`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`PUT /compliance/processing-activities/{id}/dpia`}),` — braucht ein Admin-\noder Owner-API-Key. Zeichnet (oder ersetzt) die Art. 35-Assessment\nfür die Aktivität.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.orbit.devotel.io/api/v1/compliance/processing-activities/processingActivity_7kf2…/dpia`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: dv_live_sk_...\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"necessity_proportionality\": \"Anrufaufzeichnung ist auf Support-Linien begrenzt; Aufbewahrung ist auf 90 Tage gecapt; Zugang ist auf das Support-Ops-Team eingeschränkt.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"risks_identified\": [\"Unauthorisiertes Zugang zu Aufzeichnungen\", \"Aufbewahrung jenseits des angegebenen Zwecks\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"likelihood\": \"medium\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"severity\": \"high\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"mitigations\": [\"Roll-restricted Zugang\", \"Automatisierte Löschung bei 90 Tagen\", \"Zugangs-Audit-Trail\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"residual_risk\": \"medium\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"dpo_consulted\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"outcome\": \"proceed_with_safeguards\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Feld`}),_jsx(_components.th,{children:`Typ`}),_jsx(_components.th,{children:`Notizen`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`necessity_proportionality`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` Art. 35(7)(b).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`risks_identified`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Risiken für die Rechte und Freiheiten von Datenobjekten.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`likelihood`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` `,_jsx(_components.code,{children:`low`}),`, `,_jsx(_components.code,{children:`medium`}),`, `,_jsx(_components.code,{children:`high`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`severity`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Erforderlich.`}),` `,_jsx(_components.code,{children:`low`}),`, `,_jsx(_components.code,{children:`medium`}),`, `,_jsx(_components.code,{children:`high`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`mitigations`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`Art. 35(7)(d) — Maßnahmen, die envisagitiert, um die Risiken zu adressieren.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`residual_risk`})}),_jsx(_components.td,{children:`enum`}),_jsx(_components.td,{children:`Risiko verbleibend nach mitigations. Defaults auf die Likelihood × Severity Matrix-Rating, wenn omittt.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`dpo_consulted`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Art. 35(2).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`outcome`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[`Art. 35(7)(d)-Entscheid: `,_jsx(_components.code,{children:`proceed`}),`, `,_jsx(_components.code,{children:`proceed_with_safeguards`}),`, `,_jsx(_components.code,{children:`consult_authority`}),`, `,_jsx(_components.code,{children:`do_not_proceed`}),`. Defaults auf `,_jsx(_components.code,{children:`proceed_with_safeguards`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`consult_authority`}),` mapped auf die Art. 36-Prior-Consultation-Pflicht,\ngeschuldet wenn ein high-Residual-Risiko nicht mitigiert werden kann.\nEin Ergebnis von `,_jsx(_components.code,{children:`do_not_proceed`}),` blockiert die Aktivierung der\nAktivität — lassen Sie es nur, wenn die Assessment schließlich\nschließt, dass die Verarbeitung rechtmäßig nicht gehen kann.`]}),`\n`,_jsxs(_components.p,{children:[`Jede DPIA zeichnet, wer assessed und wann (`,_jsx(_components.code,{children:`assessedAt`}),`, `,_jsx(_components.code,{children:`assessedBy`}),`).`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`das-art-30-inventar-exportieren`,children:`Das Art. 30-Inventar exportieren`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`GET /compliance/processing-activities/inventory`}),` gibt das ganze\nRegister serialisiert in der Audit-ready-Form zurück — das Attachment,\ndas ein DPO einem Aufsichtsbehörde auf einer Art. 30(4)-Anfrage\nübergibt oder an einen Auditor-Evidence-Request attached.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.orbit.devotel.io/api/v1/compliance/processing-activities/inventory`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: dv_live_sk_...\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-24T09:30:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recordCount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"records\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ROPA-2026-0004\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Kundensupport-Anrufaufzeichnungen\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"purpose\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Qualitätssicherung und Streitbeilegung für Support-Interaktionen.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"controllerRole\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"controller\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lawfulBasis\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"legitimate_interests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dataSubjectCategories\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Kunden\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Prospects\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dataCategories\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Audioaufzeichnungen\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Anrufernummer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Agent-Notizen\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"specialCategories\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recipients\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Support-Ops-Team\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"crossBorderTransfers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"transferSafeguard\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"retentionPeriod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"90 Tage nach Anruf, dann gelöscht\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"securityMeasures\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Verschlüsselung aufhalt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Roll-restricted Zugang\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Audit Logging\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"draft\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dpiaRequired\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dpiaTriggers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dpiaRecorded\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dpiaOutcome\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"residualRisk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Jedes Datensatz trägt seinen DPIA-Zustand — `,_jsx(_components.code,{children:`dpiaRequired`}),`,\n`,_jsx(_components.code,{children:`dpiaRecorded`}),`, `,_jsx(_components.code,{children:`dpiaOutcome`}),`, `,_jsx(_components.code,{children:`residualRisk`}),` — sodass das Inventar\nsich als Evidenz verdoppelt, dass hochriskante Verarbeitung gescreent\nund assessed wurde.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`zugriffskontrolle`,children:`Zugriffskontrolle`}),`\n`,_jsxs(_components.p,{children:[`Reads (`,_jsx(_components.code,{children:`GET`}),`) sind für jedes authentifizierte Mitglied Ihrer\nOrganisation offen. Writes (`,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, `,_jsx(_components.code,{children:`PUT …/dpia`}),`) sind\nErnst auf `,_jsx(_components.strong,{children:`Owner`}),` und `,_jsx(_components.strong,{children:`Admin`}),`-Rollen — das Register ist ein\nregulatorisches Kontrolle, in Einklang mit dem Rest der\nCompliance-Schreibfläche (Breach-Incidents, Aufbewahrungs-Policy).\nJedes Intake, Update und DPIA-Aufzeichnung ist in Ihrem Audit-Log\nmit dem Actor, der Aktivitäts-Referenz und dem Ergebnis geschrieben.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`verwandte-referenzen`,children:`Verwandte Referenzen`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/compliance/gdpr-posture-guide`,children:`Eine DSGVO-Posture-End zu Ende zusammenbauen`}),`\n— die Sequenz, die das Register ein Stadium von dokumentiert.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/compliance/dsar`,children:`Datenobjekt-Zugangs-Anfragen (DSAR)`}),` — die andere\nHälfte von DSGVO: das Empfangen, Verifizieren und Erfüllen von\nSubject-Access-, Erasure- und Portability-Anfragen über DSGVO,\nCCPA/CPRA, LGPD, PDPA und DPDP.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/compliance/consent-management`,children:`Consent Management`}),` — aufzeichnen\nund aussehen den Consent-Zustand, den eine Aktivität als ihre\nRechtsgrundlage anrufen kann.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/compliance/opt-out-suppression`,children:`Opt-Out \u0026 Unterdrückungslisten`}),` —\nwie Erasure- und Opt-Out-Ergebnisse in Unterdrückung fließen.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/endpoints/compliance`,children:`API-Referenz → Compliance`}),` —\nvolle Request/Response-Schemas (aus der Live-API regeneriert).`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"DSGVO-Verarbeitungsregister (ROPA + DPIA)","description":"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.","href":"/de/compliance/privacy-register"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"DSGVO-Verarbeitungsregister (ROPA + DPIA)","slug":"dsgvo-verarbeitungsregister-ropa-+-dpia","depth":1,"children":[]},{"title":"Was Art. 30 und Art. 35 verlangen","slug":"was-art-30-und-art-35-verlangen","depth":2,"children":[]},{"title":"Das Register ist Ihres — Orbit hält es, es nie füllt es","slug":"das-register-ist-ihres-—-orbit-hält-es-es-nie-füllt-es","depth":2,"children":[]},{"title":"Verarbeitungsaktivitäten aufzeichnen","slug":"verarbeitungsaktivitäten-aufzeichnen","depth":2,"children":[{"title":"Eine Aktivität erstellen","slug":"eine-aktivität-erstellen","depth":3,"children":[]},{"title":"Das DPIA-Screening","slug":"das-dpia-screening","depth":3,"children":[]},{"title":"Status-Lebenszyklus","slug":"status-lebenszyklus","depth":3,"children":[]},{"title":"Das Register lesen","slug":"das-register-lesen","depth":3,"children":[]}]},{"title":"Eine DPIA aufzeichnen","slug":"eine-dpia-aufzeichnen","depth":2,"children":[]},{"title":"Das Art. 30-Inventar exportieren","slug":"das-art-30-inventar-exportieren","depth":2,"children":[]},{"title":"Zugriffskontrolle","slug":"zugriffskontrolle","depth":2,"children":[]},{"title":"Verwandte Referenzen","slug":"verwandte-referenzen","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"zeelaltd","siteName":"Devotel Orbit Documentation","title":"DSGVO-Verarbeitungsregister (ROPA + DPIA) - Devotel Orbit Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T13:23:20.824Z","originalFileLocation":"de/compliance/privacy-register.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Devotel Orbit Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"DSGVO-Verarbeitungsregister (ROPA + DPIA) - Devotel Orbit Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Devotel Orbit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbit.devotel.io/de/compliance/privacy-register\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeelaltd.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=DSGVO-Verarbeitungsregister+%28ROPA+%2B+DPIA%29\u0026amp;description=Dokumentieren+Sie+Ihre+DSGVO+Art.+30-Records+of+Processing+Activities+und+zeichnen+Sie+Art.+35+Data+Protection+Impact+Assessments+in+einem+Mandanten-eigenen+Reg\u0026amp;theme=fc1a13fff9836a459e5f3c84\u0026amp;signature=c851a638705be4d4a2888570869085dca01a230391ec21704b006d33e806a827\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"DSGVO-Verarbeitungsregister (ROPA + DPIA) - Devotel Orbit Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeelaltd.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=DSGVO-Verarbeitungsregister+%28ROPA+%2B+DPIA%29\u0026amp;description=Dokumentieren+Sie+Ihre+DSGVO+Art.+30-Records+of+Processing+Activities+und+zeichnen+Sie+Art.+35+Data+Protection+Impact+Assessments+in+einem+Mandanten-eigenen+Reg\u0026amp;theme=fc1a13fff9836a459e5f3c84\u0026amp;signature=c851a638705be4d4a2888570869085dca01a230391ec21704b006d33e806a827\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zeelaltd/OZczcmQ6pFioqvBy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Devotel Orbit Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#325FEC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbit.devotel.io/de/compliance/privacy-register\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/de/compliance/privacy-register.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbit.devotel.io/#organization\",\"name\":\"Devotel Orbit Documentation\",\"url\":\"https://docs.orbit.devotel.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeelaltd/MGUsS3FF5JAMebgK/logo/light.svg?fit=max\u0026auto=format\u0026n=MGUsS3FF5JAMebgK\u0026q=85\u0026s=379027fc60301d5269699b31297af81f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbit.devotel.io#website\",\"name\":\"Devotel Orbit Documentation\",\"url\":\"https://docs.orbit.devotel.io\",\"publisher\":{\"@id\":\"https://docs.orbit.devotel.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbit.devotel.io/de/compliance/privacy-register#webpage\",\"url\":\"https://docs.orbit.devotel.io/de/compliance/privacy-register\",\"name\":\"DSGVO-Verarbeitungsregister (ROPA + DPIA)\",\"description\":\"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\",\"dateModified\":\"2026-09-17T13:23:20.824Z\",\"isPartOf\":{\"@id\":\"https://docs.orbit.devotel.io#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.orbit.devotel.io/de/compliance/privacy-register#article\",\"headline\":\"DSGVO-Verarbeitungsregister (ROPA + DPIA)\",\"name\":\"DSGVO-Verarbeitungsregister (ROPA + DPIA)\",\"description\":\"Dokumentieren Sie Ihre DSGVO Art. 30-Records of Processing Activities und zeichnen Sie Art. 35 Data Protection Impact Assessments in einem Mandanten-eigenen Register mit einem exportierbaren Audit-Inventar.\",\"url\":\"https://docs.orbit.devotel.io/de/compliance/privacy-register\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbit.devotel.io/de/compliance/privacy-register#webpage\"},\"dateModified\":\"2026-09-17T13:23:20.824Z\",\"publisher\":{\"@id\":\"https://docs.orbit.devotel.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbit.devotel.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Devotel Orbit Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Devotel Orbit Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Introduction to Orbit by Devotel","href":"/introduction"},{"title":"Quickstart: send your first SMS, call, or email","href":"/quickstart"},{"title":"Voice quickstart: place your first AI voice call","href":"/voice/quickstart"},{"title":"Outbound calls with an AI voice agent","href":"/voice/ai-agent-outbound-calls"},{"title":"Return an escalated call to the AI agent (handback)","href":"/voice/ai-agent-handback"},{"title":"Emergency Calling (911 / 112 / 999 / 000)","href":"/voice/emergency-calling"},{"title":"Hot-desking (shared-device sign-in)","href":"/voice/hot-desking"},{"title":"Per-user call forwarding (Find Me / Follow Me)","href":"/voice/call-forwarding"},{"title":"Browser softphone network requirements for corporate networks","href":"/voice/network-requirements"},{"title":"Hold and pause reason codes: tagging why agents hold a call or step away","href":"/voice/hold-reason-codes"},{"title":"IVR intents: NLU routing for inbound voice callers","href":"/voice/ivr-intents"},{"title":"Paging groups, ring groups \u0026 call park","href":"/voice/paging-ring-groups-call-park"},{"title":"Inbound queue SLA forecast: pre-suggest callback before breach","href":"/voice/sla-breach-forecast-callbacks"},{"title":"Inbound queue SLA forecast + virtual callback gate","href":"/voice/queue-sla-forecast-callback"},{"title":"Voice queue callbacks with SLA policies and scheduling","href":"/voice/callbacks-scheduling"},{"title":"Per-queue SLA breach alerting and escalation policies","href":"/voice/queue-sla-escalation-policies"},{"title":"Queue SLA breach: worked SDK samples","href":"/voice/queue-sla-breach-samples"},{"title":"Dialer dispositions: outbound call outcome routing","href":"/voice/dialer-dispositions"},{"title":"Wrap-up codes: disposition capture on every conversation","href":"/voice/wrap-up-codes"},{"title":"Call disposition tags: tenant-wide call labeling","href":"/voice/call-disposition-tags"},{"title":"Call QA scorecards: rubric grading, trends, and auto-scoring","href":"/voice/call-qa-scorecards"},{"title":"Voice Agent Quality Index (VAQI): latency, turn-taking, and barge-in","href":"/voice/vaqi"},{"title":"Searchable recording and transcript library (QA)","href":"/voice/recording-library"},{"title":"Secure payment capture: take card numbers in a live call","href":"/voice/secure-payment-capture"},{"title":"Attendant console: run a front desk from one screen","href":"/voice/attendant-console"},{"title":"Agent hand-raise: request assistance on a live call","href":"/voice/agent-hand-raise"},{"title":"Colleagues: live presence and click-to-call","href":"/voice/colleagues"},{"title":"BLF presence: live extension state over REST and SSE","href":"/voice/blf-presence"},{"title":"Voice extensions (SIP credentials)","href":"/voice/extensions"},{"title":"Voice conferences: create, manage, and end conference bridges","href":"/voice/conferences"},{"title":"Conference failure-attribution analytics","href":"/voice/conferences-failure-analytics"},{"title":"Live call transcription","href":"/voice/live-call-transcription"},{"title":"Live transcript streaming","href":"/voice/transcript-stream"},{"title":"Transcription operations","href":"/voice/transcription-operations"},{"title":"Bring your own speech credentials (STT/TTS)","href":"/guides/voice-byo-speech-credentials"},{"title":"Live-call speech failover on Classic and outbound calls","href":"/voice/live-call-stt-failover"},{"title":"Supervisor live speech analytics stream","href":"/guides/supervisor-live-speech-analytics-stream"},{"title":"Authenticate Orbit API requests with keys and tokens","href":"/authentication"},{"title":"Docs languages and translations","href":"/docs-languages"},{"title":"Docs contribution guide","href":"/docs-contribution-guide"},{"title":"Settings hub: map and posture","href":"/settings/overview"},{"title":"Settings: CSAT console walkthrough","href":"/guides/settings-csat-console"},{"title":"Settings → Integrations: OAuth and credential connections","href":"/guides/settings-integrations-console"},{"title":"Settings: Native Chat channel toggles","href":"/guides/settings-channels-native-chat"},{"title":"Settings: Telegram channel connection and toggles","href":"/guides/settings-channels-telegram"}]},{"group":"Channels","pages":[{"title":"Send and receive SMS messages worldwide","href":"/channels/sms"},{"title":"Send picture and multimedia messages over MMS","href":"/channels/mms"},{"title":"Send and receive WhatsApp Business messages","href":"/channels/whatsapp"},{"title":"Apple Messages for Business","href":"/channels/apple-messages"},{"title":"RCS Business Messaging: rich cards, carousels, branding","href":"/channels/rcs"},{"title":"Send Viber business and SMPP-tier messages","href":"/channels/viber"},{"title":"Send and receive Telegram bot messages","href":"/channels/telegram"},{"title":"USSD channel for 2G and feature-phone menu sessions","href":"/channels/ussd"},{"title":"Send and receive LINE messages through Orbit","href":"/channels/line"},{"title":"Send KakaoTalk Alimtalk and Friendtalk messages","href":"/channels/kakao"},{"title":"Send Zalo ZNS template messages in Vietnam","href":"/channels/zalo"},{"title":"Send WeChat Official Account template messages","href":"/channels/wechat"},{"title":"Send and receive Instagram Direct Messages","href":"/channels/instagram"},{"title":"Send and receive Facebook Messenger conversations","href":"/channels/messenger"},{"title":"Install Orbit into a Slack workspace via OAuth","href":"/channels/slack"},{"title":"Send transactional and marketing email with Orbit","href":"/channels/email"},{"title":"Send email through the SMTP relay","href":"/channels/email-smtp-relay"},{"title":"Programmable voice calls, SIP trunks, and IVR flows","href":"/channels/voice"},{"title":"STIR/SHAKEN attestation on Orbit voice","href":"/channels/voice/stir-shaken"},{"title":"Troubleshooting: SIP trunk down or calls failing","href":"/channels/voice/sip-trunks-troubleshooting"},{"title":"SIP trunk health and connectivity diagnostics","href":"/voice/sip-trunk-health-and-diagnostics"},{"title":"Video: rooms, embeds, recording, and broadcast","href":"/channels/video"},{"title":"Send and receive faxes on Orbit fax numbers","href":"/channels/fax"},{"title":"Mobile and web push notifications via APNs and FCM","href":"/channels/push"},{"title":"Issue Apple and Google Wallet passes","href":"/channels/wallet-passes"},{"title":"Native Chat setup and styling","href":"/guides/native-chat-widget-channel-config"},{"title":"Cross-channel delivery and engagement analytics","href":"/channels/analytics"}]},{"group":"Channels (Voice)","pages":[{"title":"Choose the right voice product","href":"/guides/voice-choose-product"},{"title":"Voice calendars","href":"/guides/voice-calendars"},{"title":"Voice teams: create, staff, and route to them","href":"/guides/voice-teams"},{"title":"Agent first-week onboarding journey","href":"/guides/agent-first-week-onboarding-journey"},{"title":"Pull a packet capture (pcap) for a voice call","href":"/guides/voice-packet-capture"}]},{"group":"AI Agents","pages":[{"title":"AI agents on Orbit: build, deploy, and monitor","href":"/agents/overview"},{"title":"The Agents workspace map","href":"/guides/agents-hub-overview"},{"title":"Introduction to voice AI agents","href":"/agents/intro-to-voice-ai-agents"},{"title":"Cross-channel agent memory plane","href":"/agents/memory-plane"},{"title":"Agent memory administration","href":"/agents/memory-administration"},{"title":"Creating AI agents: prompts, tools, and deployment","href":"/agents/creating-agents"},{"title":"Config assistant: propose changes in plain language","href":"/agents/config-assistant"},{"title":"Prompt Template Library: browse, fork, and seed a new agent","href":"/agents/prompt-templates"},{"title":"Conversation flows: route every agent turn through a versioned node graph","href":"/agents/conversation-flows"},{"title":"Agent squads: route inbound to the right specialist","href":"/agents/squads"},{"title":"Ambient agents: proactive outreach from segments","href":"/agents/ambient-outreach"},{"title":"Ambient sound bed for voice agents","href":"/agents/ambient-sound-bed"},{"title":"Agent model selection: LLM resolution order","href":"/agents/model-selection"},{"title":"Fine-tuning: dataset export to deployed custom model","href":"/agents/fine-tuning"},{"title":"Agent handoff targets: allowlist downstream routing","href":"/agents/handoff-targets"},{"title":"Human-in-the-loop oversight","href":"/agents/human-in-the-loop-oversight"},{"title":"Live conversation monitor","href":"/agents/live-monitor"},{"title":"Agent cost controls: run, token, and iteration limits","href":"/agents/cost-controls"},{"title":"Automation Opportunity Miner: what the surface shows and what scaffold creates","href":"/agents/automation-opportunities"},{"title":"Guardrail effectiveness monitoring: read firing rates and tune policies","href":"/agents/guardrail-effectiveness"},{"title":"Agent governance policies: guardrails, budget caps, model allowlists, approval gates","href":"/agents/agent-governance-policies"},{"title":"Sensitive words guardrail: redact operator-defined terms from agent output","href":"/agents/sensitive-words-guardrail"},{"title":"Per-turn grounding citations: audit what an agent grounded a reply on","href":"/agents/grounding-citations"},{"title":"Inspect a knowledge document's chunks","href":"/agents/kb-document-inspector"},{"title":"Agent versions: snapshot, stage, and roll back prompt configurations","href":"/agents/agent-versions"},{"title":"Persona-simulation harness — live callers vs scripted regression mode","href":"/agents/persona-simulation"},{"title":"Simulation \u0026 Regression Eval Suite","href":"/agents/simulation-eval-suite"},{"title":"Tool-call trajectory grading","href":"/agents/tool-call-trajectory-grading"},{"title":"Adversarial red-team testing: grade your agent against attack probes","href":"/agents/red-team"},{"title":"Computer-Use Browser Tools","href":"/agents/computer-use"},{"title":"Operate governed computer-use agents from the console","href":"/guides/agent-computer-use-console"},{"title":"Read a voice-eval run in the dashboard","href":"/agents/voice-eval-runs"},{"title":"Continuous production-call eval sampling for AI voice agents","href":"/agents/continuous-production-evals"},{"title":"A2A federation: task remote agents across peers","href":"/agents/a2a-federation"},{"title":"Set up A2A federation between tenants","href":"/guides/a2a-federation-setup"},{"title":"A2A push notifications — subscribe to task lifecycle updates","href":"/guides/a2a-push-notifications"},{"title":"Bridge native-chat conversations to an A2A agent","href":"/guides/native-chat-a2a-agent-bridge"},{"title":"Authorization mandates: scoped, revocable agent authority","href":"/agents/authorization-mandates"},{"title":"The complete_checkout tool for end-to-end agentic checkout","href":"/guides/agents-complete-checkout-tool"},{"title":"Agent marketplace: pre-built AI agent templates","href":"/agents/marketplace"},{"title":"Choose and prepare an agent marketplace template","href":"/guides/ai-agent-marketplace-buyer-guide"},{"title":"Outbound country coverage matrix for agents","href":"/guides/agent-outbound-country-coverage"}]},{"group":"Campaigns","pages":[{"title":"Campaigns hub","href":"/campaigns/overview"},{"title":"Cross-schedule planner: operator walkthrough","href":"/guides/cross-schedule-planner-walkthrough"},{"title":"Campaign journeys: build, validate, simulate, and launch","href":"/campaigns/journey"},{"title":"Inspect a campaign journey simulation step by step","href":"/guides/campaign-journey-simulation-inspection"},{"title":"Build a blast or drip campaign with the create wizard","href":"/guides/campaign-create-wizard"},{"title":"Generate a campaign draft from a brief","href":"/guides/campaigns-from-brief"},{"title":"Build, simulate, and launch a campaign journey (canvas, nodes, goals)","href":"/guides/campaign-journey-builder"},{"title":"Send a campaign end-to-end: draft, audience, dry-run, launch, analytics","href":"/guides/campaign-end-to-end"},{"title":"A/B test a campaign: variants, splits, and picking a winner","href":"/guides/campaign-ab-testing"},{"title":"Smart-send timing playbook: per-contact schedules, send-time experiments, and next-best-channel","href":"/guides/campaign-smart-send-timing-playbook"},{"title":"Outbound campaigns canonical entry","href":"/guides/outbound-campaigns-canonical-entry"},{"title":"Peak-season capacity rehearsal: rate limits, pacing, caps, and the launch-day runbook","href":"/guides/peak-season-capacity-rehearsal"}]},{"group":"Flows","pages":[{"title":"Visual workflow automation with Orbit Flows","href":"/flows/overview"},{"title":"Flow Builder: drag-and-drop workflow designer","href":"/flows/builder"},{"title":"Flow starter templates: clone a working flow into your tenant","href":"/flows/templates"},{"title":"Flow Executions: debug and audit individual flow runs","href":"/flows/executions"},{"title":"Flow templates catalog: the 12 built-in starter flows","href":"/guides/flow-templates-catalog"},{"title":"Build a 7-day multichannel welcome series","href":"/guides/welcome-series-multichannel"},{"title":"Reading flow analytics: funnel drop-off and A/B results","href":"/guides/flows-analytics-reading"}]},{"group":"Numbers \u0026 Verify","pages":[{"title":"Phone numbers: search, buy, and provision inventory","href":"/numbers/overview"},{"title":"Buy, bulk, and orders: the number-buying walkthrough","href":"/numbers/buy-and-provision-operations"},{"title":"Number assignments, applications, and routing","href":"/numbers/assignments-and-applications"},{"title":"Number inventory export and low-stock alerts","href":"/numbers/inventory-export"},{"title":"Country capabilities: check number stock before search","href":"/numbers/country-capabilities"},{"title":"Regulatory preview: country requirements before purchase","href":"/numbers/regulatory-preview"},{"title":"Regulated number-purchase compliance packets","href":"/guides/regulated-number-purchase-packets"},{"title":"Number lifecycle: renew, release, and reassign numbers","href":"/numbers/lifecycle"},{"title":"Number porting: LOA upload, FOC scheduling, status timeline, and bulk CSV","href":"/numbers/porting"},{"title":"E911 emergency address registration for Orbit numbers","href":"/numbers/emergency-address"},{"title":"CNAM and caller ID branding for outbound Orbit calls","href":"/numbers/cnam"},{"title":"Number health, warming, and carrier reputation tracking","href":"/numbers/health"},{"title":"Number Lookup: validate and enrich phone numbers","href":"/numbers/lookup"},{"title":"Number masking: keep two parties' real numbers private","href":"/numbers/masking"},{"title":"Numbers console: pools, porting, subscriptions, and validation","href":"/guides/numbers-console"},{"title":"Numbers cookbook","href":"/guides/numbers-cookbook"},{"title":"Number Intelligence dashboard: console, metering, and spend caps","href":"/guides/number-intelligence-dashboard"},{"title":"Number health diagnostics console walkthrough","href":"/guides/number-health-diagnostics"},{"title":"Number backorder waitlist: get notified when an exhausted area code restocks","href":"/guides/number-backorder-waitlist"},{"title":"Provision and operate eSIM / IoT (M2M) SIMs","href":"/guides/connectivity-sim-lifecycle"},{"title":"Resell travel eSIMs to your customers","href":"/guides/esim-reseller-surface"},{"title":"Orbit Verify: OTP auth for SMS, WhatsApp, email, and voice","href":"/verify/overview"},{"title":"Verification profiles: templates, expiry, attempts, rate limits, webhooks","href":"/verify/configuration"},{"title":"MFA factor lifecycle: TOTP, passkey, push, and backup-code enrollment, verification, and lockout","href":"/verify/factor-lifecycle"},{"title":"OTP approvals: two-person sign-off for templates and resend bursts","href":"/verify/otp-approvals"},{"title":"Add SMS + TOTP 2FA to your app's login flow","href":"/guides/verify-2fa-login-recipe"},{"title":"Verify console: fraud gate, fraud score, and fallback forensics","href":"/guides/verify-console"}]},{"group":"Concepts","pages":[{"group":"Concepts overview","pages":[{"title":"Concepts hub","href":"/concepts/index"},{"title":"Dashboard map — the top navigation and where each hub lands","href":"/concepts/dashboard-map"},{"title":"Concepts overview","href":"/concepts/overview"},{"title":"UCaaS, CCaaS, and CPaaS","href":"/concepts/ucaas-ccaas-cpaas"},{"title":"Data model: envelope, identifiers, idempotency, pagination","href":"/concepts/data-model"},{"title":"API request guard pipeline: the ordered guard chain every request walks","href":"/concepts/api-request-guard-pipeline"},{"title":"The developer GraphQL shaped-read model","href":"/concepts/graphql-shaped-read-model"},{"title":"Terraform model — Orbit resources as infrastructure","href":"/concepts/terraform-provider-model"},{"title":"Operator observability: dashboards, logs, and audit — what to look at when","href":"/concepts/operator-observability-map"},{"title":"The stats surface map: dashboard workbench vs the analytics pipeline","href":"/concepts/observability-stats-surface"},{"title":"Sms overview kpi picker model","href":"/concepts/sms-overview-kpi-picker-model"},{"title":"Live tail streaming model: what the live request-log stream guarantees","href":"/concepts/live-tail-streaming-model"},{"title":"The SLA attestation and report backfill model","href":"/concepts/sla-attestation-model"},{"title":"The org-scoped status model: one incident feed, three waypoints","href":"/concepts/org-scoped-status-model"},{"title":"Public feedback and trust surfaces: idea board, community, help center, sub-processor notices","href":"/concepts/public-feedback-and-trust-surfaces"},{"title":"Sandbox, test mode, and the provisioning model","href":"/concepts/provisioning-and-test-mode"},{"title":"Sandbox model: the boundary, the synthetic providers, and promotion","href":"/concepts/sandbox-model"},{"title":"The channel test-account model: per-channel shared ladders","href":"/concepts/channel-test-account-model"},{"title":"Telegram bot dispatch and demo-account model","href":"/concepts/telegram-bot-model"},{"title":"The Sync real-time shared-state model","href":"/concepts/sync-realtime-state-model"},{"title":"Sync: WebSocket claim, spin-down, and the flush window","href":"/concepts/sync-ws-claim-and-flush-window"}]},{"group":"Messaging \u0026 Routing","pages":[{"title":"Unified termination routing","href":"/concepts/unified-termination-routing"},{"title":"The MT termination model: how outbound calls and messages leave Orbit","href":"/concepts/mt-termination-model"},{"title":"The five fallback planes: one map and how to pick one","href":"/concepts/fallback-and-cascade-planes"},{"title":"Fallback configuration worked samples: notify waterfall and cascade policy","href":"/concepts/fallback-endpoint-worked-samples"},{"title":"Choosing a sender construct — pools vs services vs inline senders","href":"/concepts/sender-identity-decision-model"},{"title":"How routing picks a sender — and where a reply lands","href":"/concepts/sender-and-routing"},{"title":"Least-cost routing (LCR) policy","href":"/concepts/least-cost-routing"},{"title":"Route preview — the pre-send what-if estimator","href":"/concepts/route-preview-model"},{"title":"TelQ live-number testing model — the sender-ID deliverability probe","href":"/concepts/telq-live-number-testing-model"},{"title":"BYO SMPP carrier lifecycle","href":"/concepts/byo-carrier-lifecycle"},{"title":"Sender resolution — which sender an outbound message goes out from","href":"/concepts/sender-resolution"},{"title":"Sender pool selection — how a pool picks one sender and stays healthy","href":"/concepts/sender-pool-selection-model"},{"title":"Number Lookup model — which data package answers which question","href":"/concepts/number-lookup-model"},{"title":"Line type and reachability classification model","href":"/concepts/line-type-and-reachability"},{"title":"The E.164 phone number format","href":"/concepts/e164-format"},{"title":"Sender identity classification model","href":"/concepts/sender-identity-classification-model"},{"title":"Toll-Free Verification and RespOrg lifecycle","href":"/concepts/toll-free-verification-resporg"},{"title":"Per-contact channel optimization: engagement-ranked dispatch","href":"/concepts/channel-optimization-model"},{"title":"Messaging services — one named bundle of sending defaults","href":"/concepts/messaging-services-model"},{"title":"Message status transition rules: the DAG every consumer must agree on","href":"/concepts/message-status-dag"},{"title":"The single message-status map: four owners, one answer","href":"/concepts/message-status-map"},{"title":"DLR and MO gateway pipeline","href":"/concepts/dlr-and-mo-pipeline"},{"title":"Inbound email parse pipeline","href":"/concepts/inbound-email-parse-model"},{"title":"Fallback on terminal DLR: per-request auto-escalation after delivery fails","href":"/concepts/multi-channel-dlr-fallback"},{"title":"The push channel model: device registry, fan-out, delivery, and VoIP call push","href":"/concepts/push-channel-model"},{"title":"The in-app channel model: pull delivery, two render classes, segment targeting, and engagement receipts","href":"/concepts/in-app-channel-model"},{"title":"The Web Chat delivery model: the owned loopback channel, zero carrier hops, persist-then-poll","href":"/concepts/web-chat-delivery-model"},{"title":"Push delivery versus inbox pull: choosing a delivery surface","href":"/concepts/push-delivery-vs-inbox-pull"},{"title":"Inbound message routing","href":"/concepts/inbound-message-routing"},{"title":"Keyword auto-reply and opt-out: the matching model","href":"/concepts/keyword-rules-model"},{"title":"Wording regions: what Orbit injects into your outbound copy","href":"/concepts/wording-templates-model"},{"title":"Social listening: mentions, queues, and supervisor controls","href":"/concepts/social-listening-model"},{"title":"Canned responses and macros — the reply library model","href":"/concepts/canned-responses-macros-model"},{"title":"Inbound message resolution","href":"/concepts/inbound-message-resolution"},{"title":"Inbound media threat scan and quarantine model","href":"/concepts/inbound-media-threat-scan-model"},{"title":"Inbound AI enrichment: detect language + auto-translate","href":"/concepts/inbound-ai-enrichment"},{"title":"Inbound attachment threat scan","href":"/concepts/inbound-attachment-threat-scan"},{"title":"The media attach pipeline: upload, scan, and per-channel delivery","href":"/concepts/media-attach-pipeline-model"},{"title":"Cross-channel fallback: the ordered chain that retries a failed send on the next channel","href":"/concepts/cross-channel-fallback"},{"title":"RCS capability check and SMS fallback: deciding whether a recipient gets rich content","href":"/concepts/rcs-fallback-and-capability"},{"title":"RCS brand and bot approval lifecycle","href":"/concepts/rcs-brand-lifecycle"},{"title":"RCS billing and metering model: what an RCS message costs, when the charge lands, and how to read it back","href":"/concepts/rcs-billing-and-metering-model"},{"title":"Channel capability coverage matrix: which channels do what, and which slot into your fallback chain","href":"/concepts/channel-capability-coverage-matrix"},{"title":"Regional OTT channel model: follower-gated delivery in KakaoTalk, Zalo, WeChat, and LINE","href":"/concepts/regional-ott-channel-model"},{"title":"Cascade failover policy and one logical message ID across legs","href":"/concepts/message-cascade-groups"},{"title":"Notify cascade cost model: per-hop price bounds and the cumulative waterfall cap","href":"/concepts/notify-cascade-cost-model"},{"title":"What omnichannel means on Orbit","href":"/concepts/what-is-omnichannel"},{"title":"Message envelope model: the canonical envelope, per-channel overrides, and the channel_chain declaration","href":"/concepts/message-envelope-model"},{"title":"Messaging windows and off-window sends: Meta DM, WhatsApp, and the no-window channels","href":"/concepts/messaging-window-model"},{"title":"Group messaging versus labeling — group flow, thread, claim, and label disambiguated","href":"/concepts/group-messaging-model"},{"title":"The routing-claim election lifecycle — destination side of a routed conversation","href":"/concepts/routing-claim-election-model"},{"title":"Batch-send model — persist-then-attempt per-recipient pipeline","href":"/concepts/batch-send-model"},{"title":"Outbound route quality and circuit breakers","href":"/concepts/outbound-route-quality-and-circuit-breakers"},{"title":"Message priority and traffic lanes: keep OTP traffic ahead of campaign bursts","href":"/concepts/message-priority-traffic-lanes"},{"title":"SMPP edge model","href":"/concepts/smpp-edge-model"},{"title":"Viber termination model","href":"/concepts/viber-termination-model"},{"title":"SMTP relay ingress model","href":"/concepts/smtp-relay-ingress-model"},{"title":"Send-side DLR model: the canonical vocabulary and absorbed-traffic receipts","href":"/concepts/send-side-dlr-model"},{"title":"The DLR model: two planes, one vocabulary","href":"/concepts/dlr-model-two-planes"},{"title":"The per-provider DLR webhook fleet and the shared status pipeline","href":"/concepts/dlr-provider-webhook-fleet"},{"title":"The per-message route-trace timeline","href":"/concepts/message-route-trace"},{"title":"Message send request lifecycle: one send from POST to provider","href":"/concepts/message-send-request-lifecycle"},{"title":"The three success statuses: delivered vs submitted_no_receipt vs sent","href":"/concepts/submitted-vs-delivered-three-successes"},{"title":"SMS segments and encoding: why one character can double the cost","href":"/concepts/sms-segments-and-encoding"},{"title":"MMS composition model","href":"/concepts/mms-composition-model"},{"title":"Proxy session (number masking) model","href":"/concepts/proxy-session-model"},{"title":"Fax: delivery \u0026 inbound-routing model","href":"/concepts/fax-delivery-model"},{"title":"Messaging data residency","href":"/concepts/messaging-data-residency"},{"title":"Number rental and your wallet: renewal, suspend, and prevent-default posture","href":"/concepts/billing-and-numbers-renewal-model"},{"title":"WhatsApp conversation cost attribution and optimization model","href":"/concepts/whatsapp-cost-attribution-model"}]},{"group":"Voice \u0026 Telephony","pages":[{"title":"Voice call lifecycle: initiated to completed, and the states in between","href":"/concepts/voice-call-lifecycle"},{"title":"Browser softphone: the client-side call lifecycle","href":"/concepts/softphone-client-lifecycle"},{"title":"The voice-broadcast model — one-to-many voice calls over the campaigns backbone","href":"/concepts/voice-broadcast-model"},{"title":"Inbound voice routing","href":"/concepts/inbound-voice-routing"},{"title":"Inbound voice routing: why the tables are shared","href":"/concepts/inbound-voice-routing-shared-catalog"},{"title":"IVR flow model and simulator","href":"/concepts/ivr-flow-model"},{"title":"Hunt and ring topologies: ring groups, paging, and find-me/follow-me","href":"/concepts/hunt-and-ring-topologies"},{"title":"The STIR/SHAKEN attestation model","href":"/concepts/stir-shaken-attestation-model"},{"title":"The PASSporT token model","href":"/concepts/passport-token-model"},{"title":"ANS Trust Card and trust registry","href":"/concepts/ans-trust-card-registry"},{"title":"Jambonz softswitch model","href":"/concepts/jambonz-softswitch"},{"title":"Jambonz verb extensions in Devotel Orbit: what the platform layers on","href":"/concepts/jambonz-extension-verbs"},{"title":"SIP credential lifecycle","href":"/concepts/sip-credential-lifecycle"},{"title":"SIP digest verification model","href":"/concepts/sip-digest-verification-model"},{"title":"Extension identity: one user endpoint spanning voice, SMS, and appearance","href":"/concepts/extension-identity-model"},{"title":"The voicemail and MWI (Message-Waiting Indicator) model","href":"/concepts/voicemail-mwi-model"},{"title":"The ACD queue model: presence, skills, dispatch, and overflow","href":"/concepts/acd-queue-model"},{"title":"Disposition and ACW model: reason codes, wrap-up timers, callbacks, suggestions, and analytics","href":"/concepts/disposition-and-acw-model"},{"title":"Agent distress alert model: the panic button, its fail-open sequence, and the audit chain","href":"/concepts/agent-distress-alert-model"},{"title":"The voice supervisor plane: monitor, whisper, takeover, and announce","href":"/concepts/voice-supervisor-plane-model"},{"title":"Call park and the lobby: the slot aliasing model","href":"/concepts/voice-call-park-lobby"},{"title":"Voice conference model: rooms, participants, and recordings","href":"/concepts/voice-conference-model"},{"title":"Wallboards and SLA telemetry: metric families, threshold alarms, and SLA policy","href":"/concepts/wallboard-and-sla-telemetry"},{"title":"Agent shrinkage: reading the per-agent state-history timeline","href":"/concepts/agent-shrinkage-and-state-history"},{"title":"The queue callback model: virtual hold, dispatch, and outcomes","href":"/concepts/queue-callbacks-model"},{"title":"The public appointment self-booking model: opt-in gate, payload, and abuse posture","href":"/concepts/public-appointment-self-booking"},{"title":"Dialer pacing: claim modes, enrollment ordering, best-time-to-dial, and the abandon ceiling","href":"/concepts/dialer-pacing-model"},{"title":"Number status map: from purchase to release","href":"/concepts/number-lifecycle"},{"title":"Number dormancy and rental spend","href":"/concepts/number-dormancy-model"},{"title":"Low DID inventory alerts and the auto-replenishment loop","href":"/concepts/number-inventory-low-stock-and-replenishment"},{"title":"Bulk Reserve model: the reservation state machine","href":"/concepts/number-bulk-reservation-model"},{"title":"Number portability: one model for port-in and port-out","href":"/concepts/number-portability-model"},{"title":"Hosted messaging: SMS enablement without porting","href":"/concepts/hosted-messaging-model"},{"title":"Number reuse, aging, and post-release posture","href":"/concepts/number-reuse-and-aging"},{"title":"Trial \u0026 shared-pool number model","href":"/concepts/number-trial-pool-model"},{"title":"Port-out lifecycle and the ownership model","href":"/concepts/number-port-out-model"},{"title":"Port-out PIN protection lifecycle","href":"/concepts/port-out-pin-protection-model"},{"title":"Connectivity SIM model: the eSIM / IoT data-line state machine","href":"/concepts/connectivity-sim-model"},{"title":"Call recording pipeline: from call end to a playable recording","href":"/concepts/call-recording-pipeline"},{"title":"Recording lifecycle: capture to retention purge, and the states in between","href":"/concepts/recording-lifecycle"},{"title":"Media planes","href":"/concepts/media-planes"},{"title":"Voice gateway: the realtime AI-voice media edge","href":"/concepts/voice-gateway-realtime-edge"},{"title":"Transport architecture","href":"/concepts/transport-architecture"},{"title":"Platform runtime map","href":"/concepts/platform-runtime-map"},{"title":"Multi-region media routing","href":"/concepts/media-region-routing"},{"title":"The video room model","href":"/concepts/video-room-model"},{"title":"The video registrant lifecycle","href":"/concepts/video-registrants-model"},{"title":"Video room templates and the background library","href":"/concepts/video-room-templates"},{"title":"Video live interpretation model","href":"/concepts/video-live-interpretation-model"},{"title":"Transcript-verified video-only gate","href":"/concepts/video-transcript-verified-gate"},{"title":"Broadcast captions and the translation model","href":"/concepts/video-caption-translation-model"},{"title":"Broadcast analytics model: live audience, in-room participation, recurring themes","href":"/concepts/broadcast-analytics-model"},{"title":"Video room engagement \u0026 chapter analytics pipeline","href":"/concepts/video-analytics-pipeline"},{"title":"Avatar bot dispatch queue","href":"/concepts/avatar-bot-dispatch-queue"},{"title":"Avatar video render lifecycle","href":"/concepts/avatar-video-render-lifecycle"}]},{"group":"Delivery \u0026 Schedulers","pages":[{"title":"Queued to sent: the outbound status primer","href":"/concepts/queued-to-sent-the-four-owner-map"},{"title":"Delivery lifecycle: queued to delivered, and the states in between","href":"/concepts/delivery-lifecycle"},{"title":"Message validity period: how long the carrier keeps retrying","href":"/concepts/message-validity-period"},{"title":"Email delivery lifecycle: bounces, complaints, and the retry queue","href":"/concepts/email-delivery-lifecycle"},{"title":"Email authoring and the seed lab: compose, compile, then measure where it lands","href":"/concepts/email-authoring-and-seed-lab"},{"title":"Email transport security: MTA-STS and TLS-RPT","href":"/concepts/email-transport-security-model"},{"title":"DMARC aggregate reports (RUA): ingest and analysis","href":"/concepts/dmarc-aggregate-ingest"},{"title":"The scheduled-sending model: how queue-park, quiet-hours gating, and fire-time form one contract","href":"/concepts/scheduled-sending-model"},{"title":"The scheduled-send lifecycle: from a future send_at to dispatch","href":"/concepts/send-at-scheduled-sends"},{"title":"Outbound send gating: the tenant-owned controls that decide whether a message dispatches","href":"/concepts/send-gating-and-quiet-hours"},{"title":"Recipient timezone resolution for quiet hours","href":"/concepts/recipient-timezone-resolution"},{"title":"NANP area-code and state resolution — inventory boundaries","href":"/concepts/nanp-area-code-and-state-resolution"},{"title":"Email quiet hours vs the marketing/lifecycle classification: where timezone restraint stops and consent starts","href":"/concepts/email-quiet-hours-and-marketing-classification"},{"title":"Deliverability Lab: pre-send content-risk lint and per-carrier delivery prediction","href":"/concepts/deliverability-lab-pre-send-scoring"},{"title":"Messaging deliverability alerting: thresholds, evaluation, and notification fan-out","href":"/concepts/messaging-deliverability-alerting"},{"title":"The cross-campaign send allocator: how concurrent campaigns share one budget","href":"/concepts/campaign-allocator-model"},{"title":"How Orbit processes work asynchronously","href":"/concepts/async-processing-model"},{"title":"Scheduler fleet model","href":"/concepts/scheduler-fleet-model"},{"title":"Operational sentinels: the status values that aren't deliveries","href":"/concepts/operational-sentinels"},{"title":"On-call and escalation policy model: rotation, timeline, and incident state","href":"/concepts/oncall-escalation-model"},{"title":"Omnichannel capacity and reservation model","href":"/concepts/omnichannel-capacity-reservation"}]},{"group":"Identity, Tenancy \u0026 Access","pages":[{"title":"Tenant isolation","href":"/concepts/tenant-isolation"},{"title":"Tenant isolation at a glance","href":"/concepts/tenant-isolation-at-a-glance"},{"title":"Tenant schema migration and evolution","href":"/concepts/tenant-schema-migration-model"},{"title":"The public catalog: a closed set of shared tables","href":"/concepts/public-catalog-tables"},{"title":"Tenant provisioning lifecycle","href":"/concepts/tenant-provisioning-lifecycle"},{"title":"Organization suspension and deletion lifecycle","href":"/concepts/org-suspension-deletion-lifecycle"},{"title":"Org and subaccount model: one vocabulary","href":"/concepts/org-and-subaccount-model"},{"title":"The subaccount organization model","href":"/concepts/subaccount-organization-model"},{"title":"Authentication and session model","href":"/concepts/authentication-model"},{"title":"Current-user preferences model","href":"/concepts/me-preferences-model"},{"title":"Signed-token public share plane: sharing with recipients who have no account","href":"/concepts/signed-token-public-share-plane"},{"title":"Account security model","href":"/concepts/account-security-model"},{"title":"Destructive-operation re-auth challenge","href":"/concepts/re-auth-challenge-model"},{"title":"The issuer-challenge model","href":"/concepts/issuer-challenges-model"},{"title":"Onboarding wizard lifecycle","href":"/concepts/onboarding-wizard-lifecycle"},{"title":"Operator plane vs tenant plane — admin APIs and their audit model","href":"/concepts/admin-tenant-plane-model"},{"title":"API key lifecycle and rotation: grace versus immediate","href":"/concepts/api-key-rotation-lifecycle"},{"title":"Identity federation: SAML and SCIM","href":"/concepts/identity-federation-saml-scim"},{"title":"Tenant config portability: the export/import bundle","href":"/concepts/tenant-config-portability-model"},{"title":"Roles, teams, and permissions","href":"/concepts/roles-teams-permissions"},{"title":"Team seat quota and invite enforcement","href":"/concepts/team-seat-quota-model"},{"title":"Custom fields: the definition model and the dependency-scan lifecycle","href":"/concepts/custom-fields-model"},{"title":"The contact record model","href":"/concepts/contact-record-model"},{"title":"Contact merge policy: the per-field survivorship decision tree","href":"/concepts/contact-merge-policy"},{"title":"Custom domains and managed SSL","href":"/concepts/custom-domains-and-ssl"},{"title":"The branding and theming console model","href":"/concepts/branding-and-theming-model"},{"title":"CSPaaS white-label operations","href":"/concepts/cspaas-white-label-operations"},{"title":"The composite pre-send risk verdict: four detectors, one score","href":"/concepts/risk-verdict-model"},{"title":"Synthetic-media provenance","href":"/concepts/synthetic-media-provenance"},{"title":"Redaction vault: a compliance-safe copy of every call transcript, with an audit of what was removed","href":"/concepts/redaction-vault"},{"title":"Encryption at rest: the platform envelope, and how BYOK fits on top","href":"/concepts/encryption-at-rest-model"}]},{"group":"Billing \u0026 Wallet","pages":[{"title":"The billing model map: four wallet/usage pages, one index","href":"/concepts/billing-model-map"},{"title":"Wallet spend-channel attribution: how each debit gets its channel","href":"/concepts/wallet-spend-channel-attribution-model"},{"title":"How billing meters your usage: wallet, rating, and the ledger","href":"/concepts/billing-and-wallet"},{"title":"Committed-use drawdown: the enterprise monthly commit meter","href":"/concepts/committed-use-drawdown-model"},{"title":"The outbound pause gate and the free-channel exemption","href":"/concepts/outbound-pause-and-free-channel-exemption"},{"title":"Outbound pause and the resume propagation loop","href":"/concepts/outbound-pause-recovery"},{"title":"The dunning lifecycle: a three-strike pause with a counter you cannot reset","href":"/concepts/dunning-lifecycle-model"},{"title":"Wallets, credits, and charges: how usage metering works","href":"/concepts/wallets-credits-and-charges"},{"title":"The reseller wallet funding model: one wallet per org, funded parent-down","href":"/concepts/reseller-wallet-funding-model"},{"title":"The two-phase authorize lifecycle: authorize, capture, release","href":"/concepts/two-phase-billing-lifecycle"},{"title":"eSIM reseller billing model: wallet charges and refunds on travel eSIMs","href":"/concepts/esim-reseller-billing-model"},{"title":"The outbound billing gate chain: what every send walks, in order","href":"/concepts/billing-gate-chain-model"},{"title":"Channel charge trigger model","href":"/concepts/channel-charge-trigger-model"},{"title":"RCS billing and metering model: what an RCS message costs, when the charge lands, and how to read it back","href":"/concepts/rcs-billing-and-metering-model"},{"title":"Spend alerts, burn rate, and the velocity-anomaly model","href":"/concepts/spend-anomaly-and-alert-model"},{"title":"Anomaly insights: detector shapes, baselines, and the alert handoff","href":"/concepts/anomaly-insights-model"},{"title":"Usage records: the per-record billing feed","href":"/concepts/usage-records-model"},{"title":"The usage metering pipeline: from a sent message to the wallet ledger","href":"/concepts/usage-metering-pipeline"},{"title":"Inbound cost metering: received traffic is reported, not debited","href":"/concepts/inbound-cost-metering-model"},{"title":"LLM spend attribution: feature × model × conversation, and the reconciliation behind it","href":"/concepts/llm-spend-cost-attribution-model"},{"title":"Channel cost rollup vs the billing ledger model","href":"/concepts/cost-channel-rollup-model"},{"title":"Pricing and rate resolution: how a per-operator price is attributed","href":"/concepts/pricing-rate-resolution"},{"title":"Volume-tier pricing auto-resolution: graduated rates that apply themselves","href":"/concepts/volume-tier-resolution-model"},{"title":"MCC/MNC override model — how per-operator overrides layer onto rate resolution","href":"/concepts/mccmnc-override-model"},{"title":"All-in pricing: the base rate plus the surcharge schedule","href":"/concepts/pricing-all-in-surcharges"},{"title":"What-if pricing model: rate preview over your real usage lanes","href":"/concepts/whatif-pricing-preview-model"},{"title":"FX-rate resolution: the four-source pipeline behind converted top-ups","href":"/concepts/fx-rate-resolution-pipeline"},{"title":"Reseller margin and the tax pipeline: marking up a rated amount, correctly ordered","href":"/concepts/reseller-margin-and-tax-pipeline"}]},{"group":"CDP \u0026 Intelligence","pages":[{"title":"What a Customer Data Platform (CDP) is on Orbit","href":"/concepts/what-is-a-customer-data-platform"},{"title":"The CDP event model","href":"/concepts/cdp-event-model"},{"title":"CDP streaming destinations: Kafka and Kinesis real-time egress","href":"/concepts/cdp-streaming-destinations"},{"title":"The media asset store","href":"/concepts/cdn-assets-model"},{"title":"The event-ledger projection model","href":"/concepts/event-ledger-projection-model"},{"title":"B2B accounts: golden records and hierarchy","href":"/concepts/cdp-accounts"},{"title":"Identity resolution and merge semantics","href":"/concepts/cdp-identity-resolution"},{"title":"Identity graph and device graph","href":"/concepts/cdp-identity-graph-and-device-graph"},{"title":"The contact scoring pipeline: daily cadence, batch execution, and the auditable scorer","href":"/concepts/cdp-scoring-pipeline"},{"title":"How CDP segments recompute: real-time evaluation, re-enrichment, and staleness","href":"/concepts/cdp-segment-recompute-model"},{"title":"Lists vs segments: the two membership models","href":"/concepts/list-vs-segment-membership-models"},{"title":"Three ways to materialize an audience at send time","href":"/concepts/audience-autosuggest-and-cohort-export"},{"title":"Predictive activation schedules: cadence-driven audience refresh","href":"/concepts/predictive-activation-schedule"},{"title":"CDP clean rooms: shared analytics without data egress","href":"/concepts/cdp-clean-room-model"},{"title":"CDP retention windows: per-data-class TTL governance","href":"/concepts/retention-policy-governance"},{"title":"The reverse-ETL destination model","href":"/concepts/reverse-etl-destination-model"},{"title":"The survey lifecycle: instrument, token, dispatch, scoring, and benchmark","href":"/concepts/survey-lifecycle-model"},{"title":"Conversations: the omnichannel thread model","href":"/concepts/conversations"},{"title":"Interactions: the unified cross-channel read model","href":"/concepts/interactions-unified-model"},{"title":"Interactions CSV export: the bulk-pull contract and its RBAC split","href":"/concepts/interactions-export-model"},{"title":"The team chat model: channels, huddles, presence, reactions, and attachments","href":"/concepts/team-chat-model"},{"title":"Conversation Intelligence","href":"/concepts/conversation-intelligence"},{"title":"Conversation and Call Intelligence Landscape","href":"/concepts/conversation-and-call-intelligence-landscape"},{"title":"Automation opportunities: turning conversation P\u0026L into agentable work","href":"/concepts/automation-opportunities-model"},{"title":"Session replay and search analytics","href":"/concepts/session-search-analytics"},{"title":"Global search fan-out","href":"/concepts/global-search-fan-out"},{"title":"Session replay model: recording lifecycle, two-tier storage, and playback","href":"/concepts/session-replay"},{"title":"Co-browse session model: consent postures and the privacy-masking contract","href":"/concepts/cobrowse-session-model"},{"title":"Widget flow model: runtime, web-call context, WebMCP guardrails, and trust policy","href":"/concepts/widget-flow-model"},{"title":"Next-best-product recommendations","href":"/concepts/recommendations"},{"title":"Next-best-action decisioning","href":"/concepts/decisioning"},{"title":"Analytics pipeline: from raw events to an aggregate read surface","href":"/concepts/analytics-pipeline"},{"title":"Per-tenant request metrics: how the Developer API analytics feed works","href":"/concepts/request-metrics-and-analytics-pipeline"},{"title":"Request-metrics reader gates: four bounded surfaces","href":"/concepts/request-metrics-reader-gates"},{"title":"Request Logs model: Cloud Logging under a deadline-backed read","href":"/concepts/request-logs-model"},{"title":"The insights rollup model: read-time derivations over existing events","href":"/concepts/insights-rollup-model"},{"title":"Ask-your-data copilot: how a question becomes a governed answer","href":"/concepts/ask-your-data-copilot-model"},{"title":"The carbon emissions and ESG footprint model","href":"/concepts/carbon-emissions-model"},{"title":"The personalization slots model: slot scoping, variant resolution, and lift semantics","href":"/concepts/personalization-slots-model"},{"title":"Customer-360 snapshot aggregation model: parallel fan-out, error isolation, and caching","href":"/concepts/customer-360-snapshot-model"},{"title":"CRM integration model: sync directions, object mapping, and verification","href":"/concepts/crm-integration-model"},{"title":"Import and migration lifecycle: connect → preview → run → reconcile","href":"/concepts/imports-migration-model"},{"title":"Ads attribution and lead ingestion","href":"/concepts/ads-attribution-lead-ingestion"},{"title":"CDP ad-audience incrementality","href":"/concepts/cdp-ad-audience-incrementality"}]},{"group":"AI \u0026 Automation","pages":[{"title":"AI agent architecture: flows, retrieval, tools, and the run lifecycle end to end","href":"/concepts/ai-agent-architecture"},{"title":"Canary rollout \u0026 shadow dispatch: taking a new agent version live safely","href":"/concepts/canary-and-shadow-rollout-model"},{"title":"Outcome-based AI-agent billing: pay per resolved conversation, not per token","href":"/concepts/outcome-pricing-model"},{"title":"AI-disclosure ledger: concept","href":"/concepts/ai-disclosure-ledger"},{"title":"Prompt template lifecycle: concept","href":"/concepts/prompt-template-lifecycle"},{"title":"Outbound channel templates lifecycle: concept","href":"/concepts/outbound-channel-templates"},{"title":"Orby operator assistant architecture: sessions, turns, tools, and the approval gate","href":"/concepts/orby-operator-assistant"},{"title":"Action approvals: the human-in-the-loop gate","href":"/concepts/action-approvals-model"},{"title":"PII egress guard: the last-pass scrub on agent tool arguments","href":"/concepts/pii-egress-guard-model"},{"title":"Guardrail policies and red-team gates: how agents are governed","href":"/concepts/guardrails-and-red-team-pipeline"},{"title":"Runtime turn classifiers and eval rubrics: how agent turns are judged","href":"/concepts/agent-turn-classifiers-and-eval-rubrics"},{"title":"Agent versioning and the change-log audit trail","href":"/concepts/agent-versioning-and-change-log"},{"title":"Agent run lifecycle: queued to completed, and the states in between","href":"/concepts/agent-run-lifecycle"},{"title":"The proactive outreach evaluation model: one trigger, one decision, one audit row","href":"/concepts/proactive-outreach-evaluation-model"},{"title":"Agent memory model","href":"/concepts/agent-memory-model"},{"title":"Agent presence and aux-code lifecycle: the five states dispatch checks before it rings","href":"/concepts/agent-presence-lifecycle"},{"title":"The knowledge-base ingestion pipeline: from upload to retrieval-ready","href":"/concepts/knowledge-pipeline"},{"title":"Retrieval scoping and grounding integrity: how agent retrieval stays inside your data","href":"/concepts/retrieval-scoping-and-grounding-integrity"},{"title":"The no-match miner → KB auto-draft loop: unanswered questions become reviewable articles","href":"/concepts/kb-auto-draft-loop"},{"title":"How flow executions run: states, branching, async waits, and webhook hand-off","href":"/concepts/flow-execution-model"},{"title":"The branch-decision contract: from CDP to flows","href":"/concepts/cdp-and-flown-each-other-branch-decision"},{"title":"What a flow template is, and how cloning detaches it","href":"/concepts/flow-templates-model"},{"title":"BYO MCP servers for AI agents","href":"/concepts/byo-mcp-servers"},{"title":"Hosted MCP server","href":"/concepts/mcp-hosted-server"},{"title":"A2A federation model","href":"/concepts/a2a-federation-model"},{"title":"Agentic commerce authorization and checkout model","href":"/concepts/agentic-commerce-model"},{"title":"Cross-app access: Identity Assertion JWT Authorization Grant (ID-JAG)","href":"/concepts/cross-app-access-id-jag"},{"title":"The skill catalog: the canonical list of skills routing accepts","href":"/concepts/skill-catalog"},{"title":"QA evaluations and the performance leaderboard","href":"/concepts/qa-leaderboard-and-evaluations"},{"title":"Practice Studio: stateless simulated-customer roleplay sessions","href":"/concepts/practice-studio-model"},{"title":"The call-quality evaluation lifecycle","href":"/concepts/quality-evaluation-lifecycle"},{"title":"The LLM-judged evaluation ledger","href":"/concepts/llm-judged-evaluation-ledger"},{"title":"Pick a testing harness: the decision table","href":"/concepts/agent-testing-harness-picker"},{"title":"Agent A/B experiments: assignment, lift attribution, and promotion","href":"/concepts/agent-experiment-model"},{"title":"Agent playbooks: trigger-driven live guidance","href":"/concepts/voice-playbooks-model"},{"title":"Predictive routing: the trained agent-match model","href":"/concepts/predictive-routing-model"},{"title":"The squad routing model: classifier agents, handoff packets, and fallback","href":"/concepts/squad-routing-model"},{"title":"Inbox conversation push-routing (auto-assignment)","href":"/concepts/inbox-push-routing"},{"title":"Semantic response cache: serving near-duplicate first questions without a model round-trip","href":"/concepts/semantic-response-cache-model"}]},{"group":"Compliance, Send Controls \u0026 Rates","pages":[{"title":"Data placement and residency","href":"/concepts/data-placement-and-residency"},{"title":"Retention windows and deletion: the stores map","href":"/concepts/retention-windows-and-deletion"},{"title":"Consent, opt-out, and suppression: the recipient-state model","href":"/concepts/consent-and-suppression-model"},{"title":"The DSAR intake model","href":"/concepts/dsar-concept"},{"title":"Frequency-cap model: slot claims, counters, and gate order","href":"/concepts/frequency-caps-model"},{"title":"Message suppression model: the duplicate-content guard, and the two mechanisms it is not","href":"/concepts/message-suppression-model"},{"title":"Outbound gate chain: the interaction, campaign-preflight, keyword-rules, frequency-caps, and message-suppression stack","href":"/concepts/messages-gate-chain-and-suppression"},{"title":"The policy-scan pipeline model","href":"/concepts/policy-scan-pipeline-model"},{"title":"The DLP scanner model","href":"/concepts/dlp-scanner-concept"},{"title":"Outbound URL reputation and the smishing scan","href":"/concepts/url-reputation-smishing-scan"},{"title":"TCPA federal voice guard: the one 422 you can't unset","href":"/concepts/tcpa-federal-voice-guard"},{"title":"Voice pre-send gate chain: the order outbound calls are evaluated","href":"/concepts/voice-pre-send-gate-chain"},{"title":"TCPA quiet hours: federal, state, and tenant gates as one stack","href":"/concepts/federal-vs-state-vs-tenant-voice-gates"},{"title":"Omnichannel fallback compliance matrix — TCPA vs DNC vs registration per channel","href":"/concepts/omnichannel-compliance-matrix"},{"title":"The Reassigned Numbers Database (RND): how the safe-harbor scrub works end to end","href":"/concepts/reassigned-numbers-database"},{"title":"CTIA Messaging Principles as an ordered schema","href":"/concepts/ctia-messaging-principles"},{"title":"The US SMS Regulatory Model: Three Rule Books, One Control Plane","href":"/concepts/us-sms-regulatory-model"},{"title":"Tenant posture audit map — planes, ownership, and where the evidence lands","href":"/concepts/tenancy-posture-audit-map"},{"title":"The audit ledger model","href":"/concepts/audit-ledger-model"},{"title":"Tenant compliance defaults — the opt-in envelope","href":"/concepts/tenant-compliance-defaults-model"},{"title":"The tenant-owned compliance model: one page, every gate","href":"/concepts/compliance-tenant-owned-model"},{"title":"Outbound country allowlist — a tenant-owned opt-in gate","href":"/concepts/country-allowlist-gate-model"},{"title":"Country rules enumeration model: one row per country per channel","href":"/concepts/country-rules-enumeration-model"},{"title":"10DLC error taxonomy: registry rejections vs. delivery errors","href":"/concepts/tcr-vs-carrier-error-taxonomy"},{"title":"10dlc concept","href":"/concepts/10dlc-concept"},{"title":"Rate-limit and cooldown taxonomy: which limiter fired when a send returns 429","href":"/concepts/rate-limit-and-cooldown-taxonomy"},{"title":"API governance model: the org default + per-key override self-serve model","href":"/concepts/api-governance-model"},{"title":"Rate-limit and cooldown collector: how the API request boundary maps every bucket","href":"/concepts/rate-limit-cooldown-collector"},{"title":"Sender warming and reputation: how the ramp and trust kernels work","href":"/concepts/sender-warming-and-reputation"},{"title":"SMS complaint feedback loop: ingest, rollup, and auto-suppression","href":"/concepts/sms-complaint-feedback-loop"},{"title":"Spam-likelihood prediction: the score, its factors, and the remediation playbook","href":"/concepts/spam-likelihood-prediction"},{"title":"Template lifecycle and approval semantics","href":"/concepts/template-lifecycle"},{"title":"The WhatsApp WABA lifecycle — connect, register, migrate, disconnect","href":"/concepts/whatsapp-waba-lifecycle"},{"title":"WhatsApp quality and health model","href":"/concepts/whatsapp-quality-and-health"},{"title":"WhatsApp Flows and form submissions","href":"/concepts/whatsapp-flows-and-forms"},{"title":"WhatsApp Business Calling model","href":"/concepts/whatsapp-business-calling-model"},{"title":"WhatsApp Business Calling media relay","href":"/concepts/whatsapp-business-calling-media-relay"},{"title":"Verification session lifecycle: sent, checked, approved or failed","href":"/concepts/verification-lifecycle"},{"title":"The Verify fraud gate: score, verdict, and the fallback-constrained channel chain","href":"/concepts/verify-fraud-gate-timeline-model"},{"title":"The Verify dashboard: history surface, filters, and the role-access guard","href":"/concepts/verify-history-and-role-access"},{"title":"Identity risk gate: fused signals — port-event recency, SIM swap, and Silent Auth","href":"/concepts/identity-risk-gate-signals"},{"title":"Brand identity and trust score: the cross-channel verification rollup","href":"/concepts/brand-identity-trust-score"},{"title":"Fraud reputation: the shared cross-tenant network feed","href":"/concepts/network-signals-fraud-reputation"},{"title":"Network APIs and the CIBA silent-auth flow","href":"/concepts/network-apis-ciba"}]},{"group":"Webhooks \u0026 Platform Models","pages":[{"title":"Webhook delivery semantics: retries, ordering, and the dead-letter queue","href":"/concepts/webhook-delivery-semantics"},{"title":"The devotel CLI model: install, auth, profiles, and the webhook-forwarding loop","href":"/concepts/devotel-cli-model"},{"title":"Webhook fan-out: one event, many destinations","href":"/concepts/webhook-fan-out-and-event-sinks"},{"title":"Webhook subscription lifecycle: register through disable and re-enable","href":"/concepts/webhook-subscription-lifecycle"},{"title":"The SDK surface model: tiers, shared contract, and codegen","href":"/concepts/sdks-model"},{"title":"Inbound connector webhook authentication model","href":"/concepts/inbound-connector-webhook-auth-model"},{"title":"Inbound webhook debug log","href":"/concepts/inbound-webhook-debug-log"},{"title":"Idempotency and safe retries","href":"/concepts/idempotency-and-safe-retries"},{"title":"Public pixels, redirects, and short links","href":"/concepts/public-pixels-redirects"},{"title":"Web SDK and the public-key identify/track model","href":"/concepts/web-sdk-public-key-model"},{"title":"The notification model: event fan-out, categories, channels, and digests","href":"/concepts/notification-model"},{"title":"Short links, landing pages, and the publish lifecycle","href":"/concepts/short-links"},{"title":"QR code generation model","href":"/concepts/qr-code-generation-model"},{"title":"Marketplace listing lifecycle and trust model","href":"/concepts/marketplace-listing-lifecycle"},{"title":"Campaign lifecycle: draft to completed, blast vs drip vs journey","href":"/concepts/campaign-lifecycle"},{"title":"Campaign journey pipeline: enroll to funnel measurement","href":"/concepts/campaign-journey-pipeline"},{"title":"Journey enrollment fan-out: three routers, one entry chain","href":"/concepts/journey-enrollment-fan-out"},{"title":"The export families model","href":"/concepts/export-families-model"},{"title":"Event sources: the inbound consumer model","href":"/concepts/event-sources-inbound-model"},{"title":"Event consumer groups: managed offsets over the platform event stream","href":"/concepts/event-consumer-groups"},{"title":"USSD session model and the stateless menu engine","href":"/concepts/ussd-session-model"},{"title":"The WFM model: forecasting, scheduling, adherence, and the labor market","href":"/concepts/wfm-model"},{"title":"How voice biometrics verification works","href":"/concepts/voice-biometrics"},{"title":"Operate voice biometrics: thresholds, step-up, and the verification console","href":"/concepts/voice-biometrics-console"},{"title":"KBA caller verification: knowledge-based challenges on a live call","href":"/concepts/caller-verification-kba"},{"title":"MCID — the malicious-call trace model","href":"/concepts/mcid-call-trace-model"},{"title":"Voice Agent Quality Index (VAQI)","href":"/concepts/voice-agent-quality-vaq"},{"title":"Commerce checkout spine","href":"/concepts/commerce-checkout-spine"}]},{"group":"Files \u0026 Object Storage","pages":[{"title":"The media asset store","href":"/concepts/cdn-assets-model"},{"title":"Media file upload and the presign lifecycle","href":"/concepts/file-upload-and-presign-lifecycle"},{"title":"RCS demo videos: permanent share links","href":"/guides/file-video-share-link"}]},{"group":"Outbound","pages":[{"title":"Marketing hub model: wallet passes, loyalty, and referrals behind one redirect","href":"/concepts/marketing-hub-model"},{"title":"Referral program model: program → code → conversion → reward","href":"/concepts/referral-program-model"}]}]},{"group":"Features","pages":[{"title":"CXaaS: the four arcs of customer experience","href":"/guides/cxaas-four-arcs"},{"title":"Loyalty API: points, tiers, and redemption endpoints","href":"/api-reference/loyalty"},{"title":"Incentives: catalog, ledger, and fulfillment","href":"/concepts/incentives"},{"title":"Loyalty program model: points, tiers, and the CDP ledger","href":"/concepts/loyalty-program-model"},{"title":"Wallet pass lifecycle: issue, update, void","href":"/concepts/wallet-pass-lifecycle"}]},{"group":"Billing","pages":[{"title":"Billing overview","href":"/billing/overview"},{"title":"Revenue recognition","href":"/billing/revenue-recognition"},{"title":"Spend caps, budget alerts, and auto-cutoff","href":"/billing/spend-caps"},{"title":"Usage \u0026 delivery anomaly alerts","href":"/billing/usage-anomaly-alerts"},{"title":"Burn rate and wallet runway","href":"/concepts/billing-burn-rate"},{"title":"Spend caps on the dashboard","href":"/guides/spend-cap-console"},{"title":"Pricing calculator: estimate messaging, RTC, AI, and reseller payouts","href":"/billing/pricing-calculator"},{"title":"Billing Calculator: the presale cost-estimation walkthrough","href":"/guides/billing-cost-calculator"},{"title":"Inbound traffic cost metering: see what received calls and messages cost","href":"/guides/inbound-traffic-cost-metering"},{"title":"CDR export \u0026 billing reconciliation feed","href":"/billing/cdr-export-billing-reconciliation"},{"title":"CDR usage export for billing reconciliation","href":"/guides/cdr-usage-export-billing-reconciliation"},{"title":"Billing → Records: the usage record export console","href":"/guides/billing-records-export-console"},{"title":"Cryptocurrency payments","href":"/billing/crypto-payments"},{"title":"Crypto top-up API lifecycle","href":"/billing/crypto-topup-api-samples"},{"title":"Process NOWPayments crypto refunds in Orbit","href":"/billing/crypto-refunds"},{"title":"Wallet top-up currency conversion","href":"/billing/wallet-currency-conversion"},{"title":"Authorize wallet holds for multi-step purchases","href":"/guides/wallet-hold-capture"},{"title":"Rate cards: persisted price books you assign to subaccounts","href":"/billing/rate-cards"},{"title":"Cost-center chargeback: attribute spend to a department","href":"/guides/cost-center-chargeback"},{"title":"AI usage breakdown: attribute LLM spend per agent, model, and channel","href":"/guides/billing-ai-usage-split"},{"title":"What-if pricing simulator: back-test a rate card against your own traffic","href":"/guides/whatif-pricing-simulator"},{"title":"Committed-use discounts: decide, forecast, and enroll","href":"/guides/billing-committed-use-enrollment"},{"title":"Volume tiers and revenue recognition: the finance-ops workflow","href":"/guides/billing-revenue-and-volume-tiers"},{"title":"Revenue recognition: read deferred vs recognized schedules","href":"/guides/billing-revenue-recognition"},{"title":"Billing ops: invoices, statements, pay-by-link, and the price calculator","href":"/guides/billing-invoices-statements-and-pay-by-link"},{"title":"Run and download reseller invoices for subaccounts","href":"/guides/subaccounts-reseller-invoice-run"},{"title":"The invoice, statement, and subscription model","href":"/concepts/billing-documents-model"},{"title":"The pricing-preview pipeline: projected margin and payout before close","href":"/concepts/billing-pricing-preview-model"},{"title":"MCCMNC overrides: per-carrier rate overrides over the default rate card","href":"/guides/billing-mccmnc-overrides"},{"title":"Admin: Voice Destinations dial-code deck","href":"/guides/admin-voice-destinations-dial-code-deck"},{"title":"Per-operator SMS rates: maintain MCC/MNC rates per country","href":"/guides/billing-mccmnc-per-operator-rates"},{"title":"Configure wallet auto-top-up","href":"/guides/billing-auto-topup"},{"title":"Billing → Payment: methods, subscription, tax, outcome pricing","href":"/guides/billing-payment-surface"},{"title":"Notification digest vs. per-user preferences","href":"/guides/digest-and-notification-channels-faq"}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview: receive real-time Orbit events","href":"/webhooks/overview"},{"title":"Build your first webhook receiver","href":"/webhooks/first-receiver"},{"title":"Webhook events: catalog of every event Orbit dispatches","href":"/webhooks/events"},{"title":"Webhook event payloads: envelope, headers, and metadata","href":"/webhooks/event-payloads"},{"title":"Inbound event catalog: every inbound status folded to its canonical webhook event","href":"/webhooks/inbound-event-catalog"},{"title":"Normalized inbound event envelope","href":"/webhooks/normalized-inbound-envelope"},{"title":"Inspect webhook deliveries and replay failures","href":"/webhooks/inspecting-deliveries"},{"title":"Webhook security: verify HMAC-SHA256 signatures","href":"/webhooks/security"},{"title":"Troubleshooting: webhook signature verification failures","href":"/webhooks/troubleshooting-signature-failures"}]},{"group":"Security \u0026 SSO","pages":[{"title":"Enroll SAML SSO: Okta and Microsoft Entra ID","href":"/guides/saml-sso-enrollment"},{"title":"SCIM 2.0 provisioning (Okta, Entra ID, generic IdPs)","href":"/compliance/scim-provisioning"},{"title":"Wire SCIM provisioning: Okta, Microsoft Entra ID, and OneLogin","href":"/guides/scim-provisioning"},{"title":"Password reset and API-key revocation","href":"/guides/auth-password-reset-and-key-revocation"}]},{"group":"Compliance","pages":[{"title":"Your Tenant Compliance Posture: The Toggle Map","href":"/compliance/posture-overview"},{"title":"TCPA State-by-State Map for 2026","href":"/compliance/tcpa-state-map-2026"},{"title":"Compliance hub route map","href":"/compliance/compliance-hub-route-map"},{"title":"Compliance hub console FAQ","href":"/compliance/console-compliance-hub-faq"},{"title":"Compliance hub by role: where each persona starts","href":"/compliance/persona-guide-compliance-officer"},{"title":"Accessibility in business messaging","href":"/compliance/accessibility-business-messaging"},{"title":"Compliance Glossary","href":"/compliance/glossary"},{"title":"Compliance Posture FAQ","href":"/compliance/posture-faq"},{"title":"Quiet Hours FAQ: Org Gate vs. Campaign Fallback vs. Preview","href":"/compliance/quiet-hours-faq"},{"title":"Voice Traffic-Lane and Voice-Classification FAQ","href":"/compliance/voice-lane-and-classification-faq"},{"title":"Compliance FAQ: sends, calls, and registration gates","href":"/compliance/faq"},{"title":"Compliance Approval Timelines \u0026 Trigger Runbooks","href":"/compliance/topic-faq"},{"title":"One Educated Customer, Ten Laws: Which Regulatory Family Owns Which Customer-Data Gate","href":"/compliance/ten-vs-educate-customer-data"},{"title":"Vertical Compliance Bundles","href":"/compliance/vertical-bundles"},{"title":"Vertical bundles console walkthrough","href":"/guides/compliance-vertical-bundles-walkthrough"},{"title":"Vertical bundles by industry: a decision guide for regulated buyers","href":"/compliance/vertical-bundle-industry-guides"},{"title":"Industry landing pages: the buyer surface for each vertical","href":"/guides/industries-overview"},{"title":"Automotive recall service walkthrough","href":"/guides/automotive-recall-service-walkthrough"},{"title":"Staffing shift coverage and candidate pipeline: an end-to-end walkthrough","href":"/guides/staffing-shift-coverage-candidates-walkthrough"},{"title":"Real estate showing, listing, and closing notifications end to end","href":"/guides/real-estate-showing-closing-walkthrough"},{"title":"Build an end-to-end FNOL and claims lifecycle program","href":"/guides/insurance-claims-fnol-walkthrough"},{"title":"Configure Your Tenant's Compliance Posture Before the First Send","href":"/compliance/tenant-posture-first-run"},{"title":"Assembling a GDPR Posture End to End","href":"/compliance/gdpr-posture-guide"},{"title":"GDPR International Transfers","href":"/compliance/gdpr-international-transfers"},{"title":"CCPA/CPRA Posture: Consumer Rights on Orbit","href":"/compliance/ccpa-cpra-posture"},{"title":"US State Privacy Posture: The 2026 Map Beyond California","href":"/compliance/us-state-privacy-posture"},{"title":"COPPA and minor contacts posture","href":"/compliance/coppa-minors-posture"},{"title":"Assembling a US Marketing-SMS Posture End to End","href":"/compliance/tcpa-posture-guide"},{"title":"TCPA Consent-Record Defense Runbook","href":"/compliance/tcpa-consent-record-defense"},{"title":"Assembling a STIR/SHAKEN Outbound Posture End to End","href":"/compliance/stir-shaken-posture-guide"},{"title":"STIR/SHAKEN evidence-to-posture crosswalk","href":"/compliance/stir-shaken-evidence-crosswalk"},{"title":"Assembling a HIPAA Posture End to End","href":"/compliance/hipaa-posture-guide"},{"title":"Voice biometrics privacy posture: consent, retention, and deletion under BIPA, CUBI, MHMDA, and GDPR","href":"/compliance/voice-biometrics-bipa-posture"},{"title":"HIPAA compliance controls for healthcare messaging","href":"/compliance/hipaa"},{"title":"Business Associate Agreement (BAA) flow","href":"/compliance/baa"},{"title":"HIPAA BAA gate evaluation guide","href":"/compliance/baa-gate-guide"},{"title":"HIPAA tenant BAA attestation checklist — first run","href":"/compliance/hipaa-first-run-checklist"},{"title":"PHI-adjacent audience designations","href":"/compliance/phi-audiences"},{"title":"AI Turn Audit: Verbatim AI Decision Records","href":"/compliance/ai-turn-audit"},{"title":"Agent Identity Governance: NHI Inventory + Bulk Decommission","href":"/compliance/agent-identity-governance"},{"title":"Set up agent identity governance: inventory, sponsors, and bulk decommission","href":"/guides/agent-identity-governance-setup"},{"title":"Plan per-agent channel concurrency caps","href":"/guides/agent-channel-concurrency-caps"},{"title":"HIPAA onboarding: from BAA to audit-ready","href":"/guides/hipaa-onboarding"},{"title":"HIPAA first-enablement runbook","href":"/guides/hipaa-first-enablement"},{"title":"HIPAA readiness checklist — pre-go-live runbook","href":"/compliance/hipaa-checklist-runbook"},{"title":"Register PHI-adjacent audiences","href":"/guides/hipaa-phi-audiences"},{"title":"Build a HIPAA-postured patient engagement program","href":"/guides/healthcare-patient-engagement-walkthrough"},{"title":"Free Tool: STIR/SHAKEN Attestation Checklist","href":"/guides/stir-shaken-checklist-tool"},{"title":"EU AI Act Article 50 transparency for AI agents","href":"/compliance/eu-ai-act"},{"title":"EU AI Act deployer checklist for AI voice agents","href":"/compliance/eu-ai-act-deployer-checklist-communications-platforms-2026"},{"title":"Configure AI disclosure before you publish an agent","href":"/compliance/ai-disclosure-settings"},{"title":"AI disclosure pre-publish setup and evidence","href":"/guides/ai-disclosure-setup"},{"title":"Always-on live compliance monitoring for disclosure queues","href":"/guides/live-compliance-monitoring"},{"title":"FCC 24-17 — written consent for AI voices","href":"/compliance/fcc-ai-voice-consent-guard"},{"title":"AI outbound voice compliance checklist for 2026 buyers","href":"/compliance/ai-voice-buyer-compliance-checklist-2026"},{"title":"SOC 2 Controls Mapping","href":"/compliance/soc2-controls"},{"title":"Assembling an ISO 27001 Posture End to End","href":"/compliance/iso-27001-posture-guide"},{"title":"Access lifecycle audit evidence (SCIM join / move / leave)","href":"/compliance/access-control-audit-evidence"},{"title":"PCI DSS compliance posture and SAQ A scope for Orbit","href":"/compliance/pci-dss"},{"title":"Call Recording Consent","href":"/compliance/recording-consent"},{"title":"Consent-Receipt Integrity Binding","href":"/compliance/consent-receipt-integrity"},{"title":"Voice Signatures (Verbal Contracts)","href":"/compliance/voice-signatures"},{"title":"STIR/SHAKEN attestation posture","href":"/compliance/attestation"},{"title":"Request a STIR/SHAKEN attestation letter","href":"/guides/compliance-attestation-request-runbook"},{"title":"Posture-History Rollups for the Audit Ledger","href":"/compliance/audit-ledger-posture-rollup"},{"title":"Do-Not-Originate (DNO) Caller-ID Blocking","href":"/compliance/do-not-originate"},{"title":"CALEA Lawful-Intercept Provisioning","href":"/compliance/calea-intercept"},{"title":"Voice Data Residency \u0026 Retention","href":"/compliance/voice-data-residency"},{"title":"Data Residency Overview","href":"/compliance/data-residency-overview"},{"title":"Pin, lock, and run a governed data-residency migration","href":"/guides/data-residency-pin-lock-migrate"},{"title":"Reading the subprocessor registry","href":"/compliance/subprocessor-registry"},{"title":"Immutable Archival Export (WORM)","href":"/compliance/archival-export"},{"title":"Trust Center vs Compliance Center — which surface serves which audience","href":"/compliance/trust-center-vs-workspace"},{"title":"Trust Center evidence pack","href":"/compliance/trust-center-evidence-pack"},{"title":"Stream audit logs to your SIEM","href":"/compliance/siem-sinks"},{"title":"Audit log export, chain verification, and refresh workflow","href":"/compliance/audit-export"},{"title":"Legal Holds on Messaging Conversations","href":"/compliance/legal-hold"},{"title":"Per-Domain Data Retention Policy","href":"/compliance/data-retention-policy"},{"title":"WhatsApp Restricted \u0026 Prohibited Content Policy","href":"/compliance/whatsapp-content-policy"},{"title":"WhatsApp Meta Policy Cadence \u0026 Tenant-Owned Posture","href":"/compliance/whatsapp-meta-policy-cadence"},{"title":"Data Subject Access Requests (DSAR)","href":"/compliance/dsar"},{"title":"Proof-of-Deletion Certificate Runbook","href":"/guides/compliance-dsar-erasure-certificate-runbook"},{"title":"On-demand message redaction","href":"/guides/on-demand-message-redaction"},{"title":"Data Processing Agreement (GDPR Article 28)","href":"/compliance/data-processing-agreement"},{"title":"GDPR Processing Register (ROPA + DPIA)","href":"/compliance/privacy-register"},{"title":"Breach incident register (GDPR Art. 33/34)","href":"/compliance/breach-incident-register"},{"title":"Operate the GDPR breach-incident register","href":"/compliance/breach-incidents-gdpr-register"},{"title":"DPO \u0026 EU/UK Representative Designation (GDPR Art.37 / Art.27)","href":"/compliance/dpo-representative"},{"title":"Consent Management \u0026 Receipts","href":"/compliance/consent-management"},{"title":"The Affirmative Opt-In Gate (consent_required)","href":"/compliance/consent-required-gate"},{"title":"Confirmed Consent (Double Opt-In) Handshakes","href":"/compliance/double-opt-in"},{"title":"Opt-in disclosure templates that clear 10DLC vetting","href":"/compliance/opt-in-disclosure-templates"},{"title":"Consent Posture: The Unknown-Consent Policies","href":"/compliance/consent-default-policy"},{"title":"Ad Consent Signals: TCF, GPP, GPC \u0026 us_privacy","href":"/compliance/ad-consent-signals"},{"title":"Opt-Out \u0026 Suppression Lists","href":"/compliance/opt-out-suppression"},{"title":"Bulk-import a suppression list from CSV","href":"/guides/suppression-csv-bulk-import"},{"title":"Opt-Out Keyword Alias Table","href":"/compliance/opt-out-keyword-alias-table"},{"title":"Opt-Out Entry Points by Channel","href":"/compliance/opt-out-entry-points-by-channel"},{"title":"Preference center: tenant controls and contract","href":"/compliance/preference-center"},{"title":"Suppression vs Consent Precedence Model","href":"/compliance/consent-vs-suppression-model"},{"title":"TCPA Reasonable Revocation (2025): One-to-One Consent Vacatur and the Reasonable-Revocation Era","href":"/compliance/tcpa-reasonable-revocation-2025"},{"title":"Keyword opt-outs on WhatsApp, RCS \u0026 Viber","href":"/guides/opt-out-rules-whatsapp-rcs"},{"title":"Fraud Shield — Tenant Triage \u0026 Chargeback Evidence","href":"/compliance/fraud-shield"},{"title":"Fraud Review Triage — Run the Response Loop","href":"/compliance/fraud-review-triage"},{"title":"Inbound Country Gate — Block or Flag Inbound Origins by Country","href":"/compliance/inbound-country-gate"},{"title":"Contact PII Vault (Tokenize + Detokenize)","href":"/compliance/pii-vault"},{"title":"Brand impersonation watchlist, scan \u0026 takedown cases","href":"/compliance/brand-impersonation-takedown"},{"title":"Wire a brand-identity watchlist and run smishing takedown cases","href":"/guides/brand-impersonation-takedown"},{"title":"Branded Calling (Rich Call Data) Configuration","href":"/compliance/branded-calling"},{"title":"Voice Destination Auto-Blocks (Traffic Pumping \u0026 Wangiri)","href":"/compliance/voice-destination-auto-blocks"},{"title":"Per-channel rate overrides","href":"/compliance/channel-rate-overrides"},{"title":"Fraud caps","href":"/compliance/fraud-caps"},{"title":"Frequency Caps as a TCPA Litigation-Risk Control","href":"/compliance/frequency-caps-compliance-posture"},{"title":"View and clear spend-anomaly auto-mitigations","href":"/guides/compliance-spend-anomaly-mitigations-self-serve"},{"title":"Export Consent \u0026 Suppression Records","href":"/compliance/consent-suppression-export"},{"title":"Compliance health","href":"/compliance/compliance-health"},{"title":"Compliance Readiness Summary","href":"/compliance/compliance-readiness-summary"},{"title":"Restricted \u0026 Prohibited Industries","href":"/compliance/restricted-industries"},{"title":"Political Campaign and GOTV Messaging for the 2026 US Cycle","href":"/compliance/political-campaign-gotv-messaging-2026"},{"title":"Country Compliance Requirements","href":"/compliance/country-requirements"},{"title":"Regional Posture Hub — Per-Country Rules Index","href":"/compliance/country-rules-directory"},{"title":"Sender-ID Decision Tree by Market","href":"/compliance/sender-id-by-market-decision-tree"},{"title":"Argentina CCM/AFIP Rules","href":"/compliance/argentina-enacom-rules"},{"title":"Country Rules Auto-Refresh Feeds","href":"/compliance/country-rule-feeds"},{"title":"CPNI (FCC U.S. Telecommunications)","href":"/compliance/cpni"},{"title":"Customer-Managed Keys (BYOK)","href":"/compliance/byok-customer-managed-keys"},{"title":"BYOK: register, activate, rotate, and revoke customer-managed keys","href":"/guides/compliance-byok-keys"},{"title":"BYOK rotation and lifecycle runbook","href":"/guides/compliance-byok-rotation-runbook"},{"title":"KYC Documents \u0026 the Compliance-Profile Lifecycle","href":"/compliance/documents-kyc"},{"title":"The KYC identity model: documents, profiles, and destinations","href":"/compliance/kyc-identity-model"},{"title":"Tenant-side KYC submission and renewal runbook","href":"/compliance/kyc-profile-submission-runbook"},{"title":"Regulated number-purchase compliance packets","href":"/guides/regulated-number-purchase-packets"},{"title":"KYC Submissions \u0026 Documents: Troubleshooting","href":"/troubleshooting/kyc-submission-and-documents"},{"title":"Assemble a Shared Compliance Profile Across Gated Surfaces","href":"/compliance/compliance-profile-assembly"},{"title":"10DLC brand \u0026 campaign compliance profiles","href":"/compliance/10dlc-brand-campaign-profiles"},{"title":"10DLC preflight: score, verdict, and finding codes","href":"/compliance/10dlc-preflight-linter"},{"title":"WhatsApp Business verification as a compliance profile","href":"/compliance/whatsapp-business-verification"},{"title":"Create a compliance profile with the wizard","href":"/guides/compliance-profile-wizard"},{"title":"Compliance-profile use cases and the surface each one opens","href":"/compliance/compliance-profile-use-cases"},{"title":"Sender-ID Registration","href":"/compliance/sender-id-registration"},{"title":"Sender-ID pre-registration: the market-choosing matrix","href":"/guides/sender-id-country-matrix"},{"title":"Sender-ID registration by market: the per-market walkthrough","href":"/guides/sender-id-registration-by-market"},{"title":"Country rules console: the per-country regulation map","href":"/guides/compliance-country-rules-console"},{"title":"Country-Gate Posture Playbook","href":"/guides/country-rules-posture-playbook"},{"title":"US CAN-SPAM Compliance for Email","href":"/compliance/can-spam"},{"title":"US TCPA Junk Fax Prevention Act Compliance for Fax","href":"/compliance/tcpa-junk-fax-posture"},{"title":"Gmail \u0026 Yahoo Bulk-Sender Requirements as a Compliance Posture","href":"/compliance/email-bulk-sender-requirements"},{"title":"List-Unsubscribe Header Posture for Email Deliverability","href":"/compliance/email-list-unsubscribe-posture"},{"title":"Canada PIPEDA Posture Guide","href":"/compliance/pipeda-canada"},{"title":"Quebec Law 25 Posture Guide","href":"/compliance/quebec-law-25-posture"},{"title":"CASL (Canada's Anti-Spam Legislation) for Commercial Email","href":"/compliance/casl-canada-anti-spam"},{"title":"Australia: Spam Act 2003 and the Do Not Call Register","href":"/compliance/au-spam-act"},{"title":"New Zealand: Unsolicited Electronic Messages Act 2007","href":"/compliance/nz-uem-act-sender-rules"},{"title":"DLT-India Onboarding","href":"/compliance/dlt-india"},{"title":"India DPDP Act 2023 Posture Guide","href":"/compliance/dpdp-india"},{"title":"Philippines NTC Sender Rules","href":"/compliance/philippines-sender-rules"},{"title":"Vietnam MIC Sender Registration + Marketing Rules","href":"/compliance/vietnam-mic-sender-rules"},{"title":"Mexico NOM-184 Consent Posture","href":"/compliance/mx-nom-184-consent"},{"title":"Mexico LFPDPPP Data-Protection Posture","href":"/compliance/mexico-lfpdppp-posture"},{"title":"Colombia Habeas Data + CRC Sender Rules","href":"/compliance/colombia-habeas-data-rules"},{"title":"Chile Ley 21.719 Data-Protection Rules","href":"/compliance/chile-ley-21719-data-protection"},{"title":"Peru Ley 29733 Data-Protection Rules","href":"/compliance/peru-ley-29733-data-protection"},{"title":"UK PECR and ePrivacy for Marketing Sends and Calls","href":"/compliance/uk-pecr-eprivacy"},{"title":"Brazil LGPD + Anatel Sender Posture","href":"/compliance/lgpd-brazil"},{"title":"Brazil Anatel Sender-ID Registration Rules","href":"/compliance/brazil-anatel-sender-rules"},{"title":"Brazil A2P Messaging: Anatel, LGPD and WhatsApp","href":"/compliance/brazil-a2p-sms-anatel-lgpd-2026"},{"title":"France Marketing SMS Rules","href":"/compliance/fr-marketing-sms-rules"},{"title":"Spain AEPD + LGT Marketing Rules","href":"/compliance/spain-aepd-lgt-rules"},{"title":"Japan APPI (Act on Protection of Personal Information)","href":"/compliance/japan-appi"},{"title":"Singapore and Thailand PDPA Posture","href":"/compliance/pdpa-singapore-thailand"},{"title":"Singapore PDPA (PDPC SG + DNC Register)","href":"/compliance/singapore-pdpa"},{"title":"Thailand PDPA (PDPA B.E. 2562 + PDPC Thailand)","href":"/compliance/thailand-pdpa"},{"title":"South Korea PIPA + KISA Opt-Out Posture","href":"/compliance/south-korea-pipa"},{"title":"Germany SMS \u0026 Voice Marketing Rules (UWG + BNetzA)","href":"/compliance/germany-uwg-bnetza"},{"title":"Austria TKG 2021 + RTR/DSB Sender Rules","href":"/compliance/austria-tkg-rtr-dsb-sender-rules"},{"title":"Switzerland Revised FADP + UCA Sender Rules","href":"/compliance/switzerland-fadp-ucw-sender-rules"},{"title":"Poland UKE + RODO Sender Rules","href":"/compliance/poland-uke-rodo-sender-rules"},{"title":"Netherlands Number \u0026 Sender Rules (ACM)","href":"/compliance/netherlands-acm-rules"},{"title":"Belgium BIPT + GBA Sender Rules","href":"/compliance/belgium-bipt-gba-sender-rules"},{"title":"Ireland Number \u0026 Sender Rules (ComReg + DPC)","href":"/compliance/ireland-comreg-dpc-sender-rules"},{"title":"Finland Number \u0026 Sender Rules (Traficom, formerly FICORA)","href":"/compliance/finland-ficora-rules"},{"title":"Sweden Number \u0026 Sender Rules (PTS)","href":"/compliance/sweden-pts-rules"},{"title":"Denmark Marketing Act Sender Rules (Markedsføringsloven, Datatilsynet)","href":"/compliance/denmark-marketing-act-sender-rules"},{"title":"Norway Marketing Act Sender Rules (Markedsføringsloven, Nkom)","href":"/compliance/norway-marketing-act-sender-rules"},{"title":"Portugal ePrivacy + CNPD Sender Rules (Lei 41/2004)","href":"/compliance/portugal-eprivacy-cnpd-sender-rules"},{"title":"Indonesia KOMDIGI Sender \u0026 Marketing Rules","href":"/compliance/indonesia-komdigi-sender-rules"},{"title":"Italy AGCOM + GDPR Sender Rules","href":"/compliance/italy-agcom-sender-rules"},{"title":"South Africa POPIA Posture","href":"/compliance/south-africa-popia"},{"title":"Turkey: KVVK and BTK Sender-ID Rules","href":"/compliance/turkey-kvkk-btk"},{"title":"Uae tdra sender rules","href":"/compliance/uae-tdra-sender-rules"},{"title":"Saudi Arabia CST Sender \u0026 Marketing Rules","href":"/compliance/saudi-arabia-cst-sender-rules"},{"title":"Malaysia MCMC Sender \u0026 Marketing Rules","href":"/compliance/malaysia-mcmc-sender-rules"},{"title":"Egypt NTRA Sender \u0026 Marketing Rules","href":"/compliance/egypt-ntra-sender-rules"},{"title":"Nigeria NCC Sender \u0026 Marketing Rules","href":"/compliance/nigeria-ncc-sender-rules"},{"title":"Kenya CA Sender \u0026 Marketing Rules","href":"/compliance/kenya-ca-sender-rules"},{"title":"Israel Sender \u0026 Marketing Rules (Spam Law 2008)","href":"/compliance/israel-isa-sender-rules"},{"title":"Singapore SGNIC Sender-ID Registration Rules","href":"/compliance/singapore-sgnic-sender-rules"},{"title":"Hong Kong PCPD + OFCA Sender Rules","href":"/compliance/hong-kong-pcpd-ofca-sender-rules"},{"title":"Long-Tail Market FAQ: KVVK, PIPA, APPI, POPIA, PDPA","href":"/compliance/long-tail-market-faq"},{"title":"Compliance evidence binder","href":"/compliance/evidence-binder"},{"title":"TCPA Evidence Pack in the Binder","href":"/compliance/tcpa-evidence-binder"},{"title":"Compliance activation bundles","href":"/compliance/plugin-marketplace"},{"title":"Vertical bundles: activation lifecycle semantics","href":"/compliance/vertical-bundles-activation-semantics"},{"title":"Troubleshooting: vertical-bundle activations duplicated, checklist stuck, or version-frozen","href":"/troubleshooting/vertical-bundle-activation-duplicates"},{"title":"Compliance endpoint permissions: the role matrix","href":"/troubleshooting/compliance-endpoint-permissions"},{"title":"TCPA Known-Litigator Gate","href":"/compliance/tcpa-known-litigator"},{"title":"Send Gates: BAA, Quiet Hours, DNC, RND, RMD, Emergency Codes, DNO \u0026 Country Rate","href":"/compliance/send-gates"},{"title":"Emergency Stop: The Org-Wide Outbound Halt","href":"/compliance/emergency-stop"},{"title":"Quiet-Hours Preview: Channel-by-Channel Semantics","href":"/compliance/quiet-hours-preview"},{"title":"Emergency Stop Runbook: The Org-Wide Kill Switch","href":"/guides/compliance-emergency-stop"},{"title":"Preference center: the public opt-in/opt-out page","href":"/guides/preference-center-opt-out-page"},{"title":"Choose your suppression entry point: CSV import, Consent API, or Preference Center","href":"/guides/suppression-three-entry-points"},{"title":"Reconcile suppression across email and phone","href":"/guides/compliance-multi-address-suppression-reconciliation"},{"title":"Pre-Send Policy Scanner \u0026 DLP","href":"/compliance/policy-scanner"},{"title":"Spam-Keyword Deliverability Classifier","href":"/compliance/spam-keywords"},{"title":"AI Brand-Safety Scan","href":"/compliance/ai-brand-safety-scan"},{"title":"DLP scanner — data classes \u0026 strict mode","href":"/compliance/dlp-scanner"},{"title":"Inbox AI privacy — keep message content off the LLM","href":"/compliance/inbox-ai-privacy"},{"title":"FCC Robocall Mitigation Database (RMD): Filing Lifecycle","href":"/compliance/rmd-registration"},{"title":"FCC Robocall Mitigation Database (RMD) certification","href":"/guides/compliance-rmd-robocall-mitigation"},{"title":"Honeypot trap DIDs and the caller-reputation feed","href":"/guides/honeypot-registry-operations"},{"title":"ITG Traceback: Handling Requests for Originating Numbers","href":"/compliance/itg-traceback"},{"title":"DNC Scrubbing: Sources, Freshness, and the Check Endpoint","href":"/compliance/dnc-scrub"},{"title":"Short-code preflight: checks and remediation","href":"/compliance/shortcode-preflight"},{"title":"Carrier Deactivation (Churn) Scrub: List Hygiene Against Carrier Disconnects","href":"/compliance/deactivation-scrub"},{"title":"Finalize-and-purge runbook: the 24-hour recording lifecycle after deactivation","href":"/guides/deactivation-scrub-minimization-runbook"},{"title":"Recycled-Number Complaint Hygiene: Deactivation, RND, and the List Scrub Working Together","href":"/guides/compliance-recycled-number-hygiene-runbook"},{"title":"RCS Universal Profile 3.0 rich deep-link guardrails","href":"/compliance/rcs-up3-guardrails"},{"title":"Report apparent CSAM to the NCMEC CyberTipline","href":"/guides/media-csam-reporting-runbook"},{"title":"Batch DNC Pre-Flight Scrubbing","href":"/guides/dnc-preflight-scrub"},{"title":"List-Hygiene Projection: DNC Suppression on the Pre-Flight Preview","href":"/guides/campaign-list-hygiene-projection"},{"title":"RND Safe-Harbor Pre-Contact Number Scrubbing","href":"/guides/rnd-safe-harbor-preflight"},{"title":"RND Scrub: FCC Reassigned Numbers Database Reference","href":"/compliance/rnd-scrub"},{"title":"US Calling Windows: Federal TCPA + State Overlays","href":"/compliance/state-calling-windows"},{"title":"Number Timezone and State Resolution","href":"/compliance/number-timezone-resolution"},{"title":"Emergency Calling: Kari's Law and RAY BAUM'S Act Posture","href":"/compliance/emergency-calling-and-karis-ray-baums-posture"},{"title":"Voice Guard: the Federal Dialing-Window Decision Check","href":"/compliance/voice-guard"},{"title":"The sole platform-global compliance guard (invariant #68)","href":"/compliance/invariant-68-explainer"},{"title":"Voice Guard Sentinel: the Observability Contract","href":"/compliance/voice-guard-sentinel-observability"},{"title":"Voice Guard Observability: the Deep-Dive Runbook","href":"/compliance/voice-guard-observability-deep-dive"},{"title":"Voice traffic-lane resolution at the federal dial gate","href":"/compliance/voice-traffic-lane-resolution"},{"title":"Dialer Abandoned-Call Safe Harbor","href":"/compliance/dialer-abandoned-call-safe-harbor"},{"title":"UK Ofcom Dropped-Call Posture","href":"/compliance/uk-ofcom-abandoned-call-posture"},{"title":"Troubleshoot a pending number or Sender ID","href":"/compliance/troubleshooting-pending-gated-surfaces"},{"title":"Troubleshoot a 'blocked' send — map the code to the gate","href":"/compliance/troubleshooting-blocked-class-errors"},{"title":"Compliance profile lifecycle errors — INCOMPLETE, REQUIRED, NOT_APPROVED, LOCKED, IN_USE","href":"/compliance/compliance-profile-lifecycle-errors"},{"title":"Carrier rejection feedback: reading your rejection reason and fixing it","href":"/compliance/carrier-rejection-feedback"},{"title":"Compliance send-gate error codes — decide the gate, own the fix, re-verify","href":"/compliance/troubleshooting-compliance-error-codes"},{"title":"Sends blocked by consent gates — 403 consent_required","href":"/troubleshooting/consent-required-blocked-sends"},{"title":"Compliance-gate error codes FAQ","href":"/compliance/compliance-gate-error-codes-faq"},{"title":"Send-gate decision fork — which check rejected your send","href":"/compliance/send-gate-decision-fork"},{"title":"The send-gate evaluation chain — which gate fires, in which order","href":"/compliance/send-gate-evaluation-chain"},{"title":"Run a quarterly compliance posture review","href":"/guides/compliance-posture-quarterly-review"},{"title":"Operating Compliance-Health Scores as an Early-Warning Signal","href":"/guides/compliance-health-alerting-runbook"},{"title":"Your first compliance posture, end to end: from tenant-owned controls to a sealed evidence binder","href":"/guides/compliance-first-evidence-binder-walkthrough"},{"title":"Assemble and seal an evidence binder, read gated surface verdicts","href":"/guides/compliance-evidence-binder"},{"title":"Fulfill a DSAR and operate the breach-incident register","href":"/guides/compliance-dsar-breach-register"},{"title":"Run the privacy register — ROPA intake, DPIA screening, and the Art.30 export","href":"/guides/compliance-privacy-register"},{"title":"Work a Fraud Shield alert end to end","href":"/guides/compliance-fraud-shield"},{"title":"Deploy the public self-service DSAR intake portal","href":"/guides/self-service-dsar-portal"},{"title":"DSAR Self-Service Portal End-to-End","href":"/guides/dsar-portal-setup"},{"title":"Execute the DPA and BAA, then manage per-call recording consent","href":"/guides/compliance-dpa-baa-recording-consent"},{"title":"Legal holds: preserve recordings and message threads from retention sweeps","href":"/guides/compliance-legal-hold"},{"title":"Third-party archive connectors: deliver records to Smarsh, Global Relay, or Bloomberg Vault","href":"/guides/compliance-archive-connectors"},{"title":"Navigating the Settings → Compliance Hub","href":"/guides/compliance-hub-navigation"},{"title":"Upload and manage compliance documents","href":"/guides/settings-compliance-documents-console"},{"title":"Compliance Translation Parity Tracker","href":"/translation-parity-compliance"}]},{"group":"Legal","pages":[{"title":"Legal index","href":"/legal/index"},{"title":"Open source attribution","href":"/legal/attribution"}]},{"group":"Brand \u0026 press","pages":[{"title":"Press and brand resources","href":"/press-kit"},{"title":"How to use the press kit","href":"/press-kit-usage-guide"}]},{"group":"Tutorials","pages":[{"title":"Compliance integration recipes","href":"/tutorials/compliance-integration-recipes"}]},{"group":"Changelog","pages":[{"title":"Orbit changelog: product updates and API changes","href":"/changelog"}]}]},{"tab":"Guides","groups":[{"group":"WhatsApp","pages":[{"title":"Get started with the WhatsApp Business Platform","href":"/guides/whatsapp/getting-started"},{"title":"WhatsApp onboarding walkthrough","href":"/guides/whatsapp/onboarding"},{"title":"Connect your first WABA end to end","href":"/guides/whatsapp-setup-first-waba"},{"title":"WhatsApp Business Account (WABA) Setup","href":"/guides/whatsapp/waba-setup"},{"title":"Connect an Additional WABA","href":"/guides/whatsapp-add-waba"},{"title":"Create and approve a WhatsApp message template","href":"/guides/whatsapp/templates-create-approve"},{"title":"BSP Transfer / Number Porting","href":"/guides/whatsapp/waba-migration"},{"title":"WhatsApp API migration parity map","href":"/guides/whatsapp/api-migration-parity"},{"title":"WhatsApp 24h freeform window","href":"/guides/whatsapp/24h-window"},{"title":"WhatsApp CTA-URL tap-to-open link buttons","href":"/guides/whatsapp/send-cta-url-button-message"},{"title":"Ask for a WhatsApp location or delivery address","href":"/guides/whatsapp/location-and-address-request-messages"},{"title":"WhatsApp Flows: interactive forms end-to-end","href":"/guides/whatsapp/whatsapp-flows"},{"title":"WhatsApp Catalog and Product Messages","href":"/guides/whatsapp/whatsapp-catalog"},{"title":"WhatsApp Business Calling","href":"/guides/whatsapp/business-calling"},{"title":"Your first support call on WhatsApp Business Calling","href":"/guides/whatsapp-business-calling-first-support-call"},{"title":"WhatsApp pricing: how Meta bills conversations","href":"/guides/whatsapp/pricing"},{"title":"Send WhatsApp marketing templates through Meta MM Lite","href":"/guides/whatsapp-mm-lite-marketing-sends"},{"title":"Run a WhatsApp marketing campaign end-to-end","href":"/guides/whatsapp/campaign-launch-playbook"},{"title":"Work the Messages → WhatsApp workspace","href":"/guides/whatsapp-workspace-walkthrough"},{"title":"AI auto-reply for WhatsApp from your knowledge base","href":"/guides/whatsapp-kb-auto-reply"},{"title":"WhatsApp business identity and verification","href":"/guides/whatsapp-business-identity"}]},{"group":"Developer console","pages":[{"title":"Developer console overview","href":"/developer/overview"},{"title":"Per-user state persistence model","href":"/guides/per-user-state-persistence-model"}]},{"group":"Contact center","pages":[{"title":"Staff your first support queue end to end","href":"/guides/first-support-queue-end-to-end"},{"title":"Set up and run voice queues","href":"/guides/voice-queues"},{"title":"Wallboard: supervisor real-time tiles for TV-mounted displays","href":"/guides/wallboard"},{"title":"Runbook: wallboard on TV — set up, rotate, and retire a shared display","href":"/guides/wallboard-tv-setup"},{"title":"Wallboard alarm rules","href":"/guides/wallboard-alarm-rules"},{"title":"On-call deep dive: from dashboard hub to a working pager","href":"/guides/oncall-deep-dive"},{"title":"On-call roster \u0026 escalation policy runbook","href":"/guides/oncall-escalation-runbook"},{"title":"Contact Center live operations floor: a first-week supervisor walkthrough","href":"/guides/contact-center-live-floor"},{"title":"Supervisor coaching: plans, templates, and effectiveness reporting","href":"/guides/supervisor-coaching"},{"title":"Define and use disposition tags","href":"/guides/voice-disposition-tags"},{"title":"Build a contact-center QA program","href":"/guides/quality-management-program"},{"title":"Build on-call alerting with the On-Call API","href":"/guides/oncall-alerting"},{"title":"Reading the Voice → Calls console: call logs, detail sheet, timeline, and analytics","href":"/guides/voice-calls-call-logs"},{"title":"Where to look first when an outbound call fails","href":"/guides/voice-call-failure-triage"},{"title":"Workforce-management workflows","href":"/guides/wfm-workflows"},{"title":"Publish your first weekly roster","href":"/guides/voice-scheduling-first-roster"},{"title":"Per-queue analytics drilldown console","href":"/guides/queue-analytics-drilldown"},{"title":"Contact-center (voice/CCaaS) go-live runbook","href":"/guides/voice-ccaas-go-live-checklist"},{"title":"PSTN voice go-live checklist: numbers, identity, routing, recording, compliance","href":"/guides/voice-telephony-go-live-checklist"},{"title":"Email sender go-live checklist: domain, sender, first send, suppression, day-two ops","href":"/guides/email-sender-go-live-checklist"}]},{"group":"Guides","pages":[{"title":"The Orbit mobile app","href":"/guides/mobile-app"},{"title":"Mobile app first-shift onboarding","href":"/guides/mobile-app-first-shift-onboarding"},{"title":"Connect Orbit to your AI coding assistant via MCP","href":"/guides/mcp-claude-cursor"},{"title":"Orbit-as-MCP: hosted server handshake and scoped tool catalog","href":"/guides/mcp-server-handshake"},{"title":"Set up cross-app access with ID-JAG-style token delegation","href":"/guides/cross-app-access-id-jag-setup"},{"title":"URL-mode elicitation: collecting sensitive values through a hosted capture page","href":"/guides/mcp-url-elicitation"},{"title":"Browse, install, and publish marketplace templates","href":"/guides/marketplace-browse-install-publish"},{"title":"Marketplace requests: from request to fulfillment","href":"/guides/marketplace-request-workflow"},{"title":"Developer Marketplace console walkthrough","href":"/guides/marketplace-console-walkthrough"},{"title":"Moderate agent template submissions","href":"/guides/agents-marketplace-moderation"},{"title":"CPaaS/CCaaS platform evaluation checklist","href":"/guides/cpaas-platform-evaluation-checklist"},{"title":"CPaaS vendor procurement checklist for 2026","href":"/guides/cpaas-vendor-procurement-2026-checklist"},{"title":"Read the Segment MTU vs event-volume cost comparison","href":"/guides/cdp-segment-migration-calculator"},{"title":"Tour the Developer hub","href":"/guides/developer-hub-overview"},{"title":"Developer console map: every developer-hub tile on one page","href":"/guides/developer-hub-consoles"},{"title":"Landing shells: what the SDK demo and conversation-operators shells actually do","href":"/guides/landing-shells-overview"},{"title":"Developer Portal: console, usage, keys, and webhook debug","href":"/guides/developer-portal"},{"title":"Work through the SDK catalog","href":"/guides/developer-sdks-catalog"},{"title":"Manage Orbit from the terminal with the devotel CLI","href":"/guides/devotel-cli"},{"title":"Drop in an Orbit widget with one HTML tag","href":"/guides/orbit-elements-web-components"},{"title":"Use the core-scope SDK escape hatch","href":"/guides/ecosystem-sdks-low-level-hatch"},{"title":"Delivery Logs console: trace one message end to end","href":"/guides/developer-delivery-logs"},{"title":"Where to look first when a message send fails","href":"/guides/diagnose-a-failed-send"},{"title":"Request Logs console: inspect API payloads","href":"/guides/api-request-logs-console"},{"title":"Developer hub overview: read the latency and success-rate cards","href":"/guides/developer-overview-page"},{"title":"API playground: build and run requests in the dashboard","href":"/guides/developer-api-playground"},{"title":"Tutorial: your first API playground request, end to end","href":"/guides/developer-api-playground-tutorial"},{"title":"The developer loop: sandbox key, playground, first live send","href":"/guides/developer-sandbox-playground-loop"},{"title":"Connector downloads: Zapier, Make, and n8n app definitions","href":"/guides/connectors-download"},{"title":"Connectors hub: browse catalogs, attach credentials, run syncs, and rotate safely","href":"/guides/connector-hub-console"},{"title":"Connected Apps: OAuth scoped access for a customer's org","href":"/guides/connected-apps"},{"title":"White-label subaccounts: provision, brand, fund, and operate","href":"/guides/subaccounts-reseller"},{"title":"Suspend, reactivate, and recover a subaccount","href":"/guides/subaccount-lifecycle-suspend-reactivate"},{"title":"New subaccount wizard: a step-by-step walkthrough","href":"/guides/subaccount-create-wizard"},{"title":"Subaccounts console: list, manage, invoice, and recover","href":"/guides/subaccounts-console"},{"title":"Sub-account notification recipients: route rate-sheet and balance-alert emails per sub-account","href":"/guides/subaccounts-notification-recipients"},{"title":"Set up a custom notification-email identity for a sub-account","href":"/guides/subaccounts-custom-notification-email"},{"title":"Multi-environment subaccounts: dev, staging, prod, and product-line isolation","href":"/guides/multi-environment-subaccounts"},{"title":"Split traffic and billing across subaccounts: staging vs production","href":"/guides/subaccount-staging-production-split"},{"title":"Per-subaccount AI configuration","href":"/guides/subaccount-ai-configuration"},{"title":"Integrate with the Orbit REST API and webhooks","href":"/guides/api-integration"},{"title":"Do idempotent requests across the Orbit API","href":"/guides/idempotent-requests"},{"title":"Choose and scope API keys for messaging, CCaaS agents, and the CDP","href":"/guides/api-keys-messaging-ccaas-cdp"},{"title":"API recipes hub: pick the recipe by flow shape","href":"/guides/api-recipes/index"},{"title":"REST API recipes: task-by-task curl and SDK cookbook","href":"/guides/api-recipes"},{"title":"CSV to launched SMS blast: the operator path end to end","href":"/guides/csv-to-launched-sms-blast"},{"title":"Goal conversion pixel: mint the sig, embed the \u003cimg>, verify with curl","href":"/guides/goal-conversion-pixel"},{"title":"API recipes: operations endpoints","href":"/guides/api-recipes/operations"},{"title":"API recipes: contact lifecycle — opt-outs, segments, frequency caps","href":"/guides/api-recipes/contacts-lifecycle"},{"title":"API recipes: the US 10DLC pre-send chain","href":"/guides/api-recipes/us-10dlc-posture"},{"title":"API recipes: third-party migrators — the per-provider concept template","href":"/guides/api-recipes/third-party-migrators"},{"title":"API recipes: message-history import and reconciliation","href":"/guides/api-recipes/message-import-reconciliation"},{"title":"Where a worked sample belongs: endpoint overlay vs recipe cookbook","href":"/guides/api-recipes-meta"},{"title":"Per-language recipes: message + DLR webhooks, batch, OTP verify, and deliverability past first send","href":"/guides/per-language-recipes"},{"title":"OpenAPI recipes cookbook: multi-call sequences over the shipped endpoints","href":"/guides/cookbook-openapi-recipes"},{"title":"Ship a sample request with the Postman collections","href":"/guides/postman-collections-recipes"},{"title":"Explore the API from the dashboard's Postman workbench","href":"/guides/postman-workbench"},{"title":"API error handling by example","href":"/guides/error-handling-examples"},{"title":"Error-handling runbook","href":"/guides/error-handling-runbook"},{"title":"The five most common error envelopes — worked end-to-end","href":"/guides/error-code-terminated-worked"},{"title":"Query related records in one request with GraphQL","href":"/guides/graphql-querying"},{"title":"Provision Orbit resources with Terraform","href":"/guides/terraform-provider"},{"title":"Starter examples","href":"/guides/starter-examples"},{"title":"How to read a worked sample","href":"/guides/using-orbit-samples"},{"title":"Quickstart: receive your first webhook","href":"/guides/first-webhook-quickstart"},{"title":"Build a durable webhook consumer","href":"/guides/webhook-consumer"},{"title":"Build a DLR-only webhook consumer","href":"/guides/dlr-webhook-consumer"},{"title":"Wire delivery-report webhooks per channel, end to end","href":"/guides/wire-dlr-webhooks-per-channel"},{"title":"Production-grade webhook consumer: end-to-end walkthrough","href":"/guides/webhook-consumer-production-checklist"},{"title":"Explore webhook event schemas from the catalog","href":"/guides/webhook-event-catalog"},{"title":"Read the inbound event catalog for carrier-folded webhook normalization","href":"/guides/webhook-inbound-event-catalog"},{"title":"Webhook payload cookbook: one payload per event family","href":"/guides/webhook-payload-cookbook"},{"title":"Verify webhook signatures with the SDK, per language","href":"/guides/verify-webhook-signatures"},{"title":"Verify webhook signatures without the SDK","href":"/guides/webhook-signature-verify-polyglot"},{"title":"Configure event sinks: Kafka or HTTP batch","href":"/guides/event-sinks-streaming"},{"title":"Configure event sources: Kafka inbound consume","href":"/guides/event-sources-inbound"},{"title":"Debug inbound carrier webhooks","href":"/guides/inbound-webhook-debugging"},{"title":"Run your first event sink deployment","href":"/guides/event-sink-first-deployment"},{"title":"Test webhooks with the Webhook Tester","href":"/guides/webhook-tester"},{"title":"Edit a webhook subscription in the console","href":"/guides/webhook-edit-console"},{"title":"Operate a webhook endpoint: signed tests, secret rotation, health, and replay","href":"/guides/webhook-endpoint-operations"},{"title":"Triage webhooks across every endpoint: the Events timeline","href":"/guides/webhook-tenant-dispatch-timeline"},{"title":"CDP event debugger and DLQ: inspect the live stream and replay failed deliveries","href":"/guides/cdp-event-debugger-and-dlq"},{"title":"Queue inspector: watch every BullMQ queue, drill into jobs, and recover in bulk","href":"/guides/queue-inspector"},{"title":"Send \u0026 Receive Messages","href":"/guides/send-receive-messages"},{"title":"Your first SMS, end to end","href":"/guides/first-sms-end-to-end"},{"title":"SMS integration loop: send, deliver, reply, and recover","href":"/guides/sms-integration-loop-walkthrough"},{"title":"Reading and customizing the SMS overview strip (Messages → SMS)","href":"/guides/sms-overview-metrics-console"},{"title":"Two-way SMS conversations without the Inbox","href":"/guides/sms-two-way-conversation"},{"title":"Keyword auto-replies with agent escalation, end to end","href":"/guides/sms-keyword-agent-escalation"},{"title":"Build a two-way SMS support line from scratch","href":"/guides/two-way-sms-support-line"},{"title":"Two-sided marketplace loop: consent gate → masked proxy → two-way SMS → Inbox → close","href":"/guides/masked-proxy-inbox-loop"},{"title":"MMS send \u0026 receive","href":"/guides/mms-send-and-receive"},{"title":"MMS media rich-content cookbook","href":"/guides/mms-media-rich-content"},{"title":"Build the in-app engagement channel: content cards + in-app messages","href":"/guides/in-app-channel-messages"},{"title":"Multi-channel Notify: one message to a mixed recipient list","href":"/guides/multi-channel-notify"},{"title":"Subscribe-many broadcast: one body to many recipients in the notify composer","href":"/guides/notify-subscribe-many"},{"title":"Cascade (waterfall) fallback chains in the notify composer","href":"/guides/notify-cascade-failover"},{"title":"Cross-channel cascade failover policy","href":"/guides/cross-channel-cascade-failover-policy"},{"title":"Track a live cascade by notify id","href":"/guides/track-a-cascade"},{"title":"Push notifications end to end: tokens, targeting, results, engagement","href":"/guides/push-integration"},{"title":"Manage iOS Live Activities end to end","href":"/guides/push-live-activities"},{"title":"Push broadcasts: credentials, payload shape, and the pre-send caps","href":"/guides/push-broadcast-caps"},{"title":"Push device tokens and scheduled sends: the data plane","href":"/guides/push-device-tokens-and-scheduled-sends"},{"title":"Push notification categories: curated interactive templates for sends","href":"/guides/push-notification-categories"},{"title":"Per-channel connection mode: BYO vs platform default for subaccounts","href":"/guides/subaccount-connection-modes"},{"title":"Inbound email and SMS routing","href":"/guides/inbound-email-parse"},{"title":"Close the email loop: inbound parse, Flow reply, ticket","href":"/guides/first-email-loop"},{"title":"Route inbound support mail to the right team and ticket","href":"/guides/inbound-email-to-ticket-route-recipes"},{"title":"One inbound email, end to end","href":"/guides/email-inbound-end-to-end"},{"title":"Inbound fax: route received faxes to email and the inbox","href":"/guides/inbound-fax-workflow"},{"title":"Inbound fax: operate the receive-side loop end to end","href":"/guides/fax-receive-workflow"},{"title":"Outbound fax: send a document end to end","href":"/guides/fax-send-workflow"},{"title":"Fax lifecycle orchestration: inbound and outbound legs","href":"/guides/fax-lifecycle-orchestration"},{"title":"Fax lifecycle in Devotel Orbit: states, timestamps, retries, and inbound routing","href":"/guides/fax-lifecycle"},{"title":"Using a video room access token","href":"/guides/video-room-access-tokens"},{"title":"Stream Video Room audio to your WebSocket","href":"/guides/video-media-fork"},{"title":"Video meetings and conferences","href":"/guides/video-meetings"},{"title":"Pre-meeting briefings","href":"/guides/video-pre-meeting-briefings"},{"title":"PSTN dial-in and SIP room systems for video rooms","href":"/guides/video-room-dial-in-and-sip-room-system"},{"title":"Persistent video rooms — create, re-open, embed","href":"/guides/video-persistent-rooms"},{"title":"Build a customer-facing video support surface","href":"/guides/video-support-surface-embed"},{"title":"Monitor in-call video quality","href":"/guides/video-quality-monitoring"},{"title":"Video room media diagnostics","href":"/guides/video-room-media-diagnostics"},{"title":"Live interpretation in video rooms","href":"/guides/video-live-interpretation"},{"title":"Video room templates: consistent rooms, one click","href":"/guides/video-room-templates"},{"title":"Video room consoles: Sessions, Widget, Templates, and Live","href":"/guides/video-room-consoles"},{"title":"Video room recording to your own bucket (BYO storage)","href":"/guides/video-recording-byo-storage"},{"title":"Serve a video room as an HLS or DASH livestream with DVR","href":"/guides/video-room-hls-dash-egress"},{"title":"Pull a broadcast source into a video room via RTMP/WHIP ingress","href":"/guides/video-room-ingress-whip-rtmp"},{"title":"WHEP in-browser guest player","href":"/guides/whep-guest-player"},{"title":"Share a video or voice recording with the public player","href":"/guides/video-recording-share-player"},{"title":"Branded video-room backgrounds","href":"/guides/video-branded-backgrounds"},{"title":"Video room history","href":"/guides/video-room-history"},{"title":"Video engagement analytics: read speaker, chapter, and room-usage metrics","href":"/guides/video-engagement-analytics"},{"title":"Add a 'video call us' button to your website","href":"/guides/embed-video-consultation-button"},{"title":"Consultation widget console","href":"/guides/video-consultation-widget-console"},{"title":"Video Room Embed Demo (Developer console)","href":"/guides/developer-video-embed-demo"},{"title":"Developer QR Code Tools","href":"/guides/qr-tools"},{"title":"Registration-gated video webinars","href":"/guides/video-webinars"},{"title":"'Registered participants only' join gate","href":"/guides/video-webinar-registration-gate"},{"title":"AI video avatar agents","href":"/guides/ai-video-avatar-agents"},{"title":"Recording view analytics: instrument a player for viewership and engagement reporting","href":"/guides/recording-view-analytics"},{"title":"Embed a voice, video, or capture widget on your site","href":"/guides/voice-web-widget"},{"title":"Set up the browser (WebRTC) softphone","href":"/guides/voice-softphone-browser-calling"},{"title":"Live interpretation and mid-call language detection on voice calls","href":"/guides/voice-live-interpretation-language-detection"},{"title":"Test your browser calling setup with the SDK demo","href":"/guides/sdk-demo-browser-softphone"},{"title":"Extensions and desk phones: SIP credentials and zero-touch provisioning","href":"/guides/extensions-and-desk-phones"},{"title":"Link a SIP extension to a user: per-user inbound VoIP ring","href":"/guides/sip-extension-user-linked-mobile-ring"},{"title":"SIP credentials: provision digest-verified device identities","href":"/guides/sip-credentials-provisioning"},{"title":"Browser Softphone — place and receive calls from the dashboard","href":"/guides/voice-browser-softphone"},{"title":"Escalate a live voice call into a video room","href":"/guides/voice-video-escalation"},{"title":"Desk phones: zero-touch provisioning","href":"/guides/voice-desk-phone-provisioning"},{"title":"Desk-phone fleet rollout: bulk zero-touch provisioning at scale","href":"/guides/voice-desk-phone-fleet-rollout"},{"title":"Extension SMS","href":"/guides/extension-sms"},{"title":"Intercom: peer-to-peer auto-answer (push-to-talk)","href":"/guides/intercom-auto-answer"},{"title":"Answer anyone's ringing call and move live calls between phones","href":"/guides/inbound-call-portability"},{"title":"Verify integration without our SDK","href":"/guides/verify-no-sdk"},{"title":"Verify in 30 minutes","href":"/guides/verify-in-30-min"},{"title":"Mobile OTP autofill for Verify","href":"/guides/verify-otp-mobile-autofill"},{"title":"Verify profiles: fallback chains, code templates, and MFA factors","href":"/guides/verify-fallback-chains"},{"title":"MFA factor suite: TOTP, push, passkeys, magic links, and backup codes","href":"/guides/verify-factor-suite"},{"title":"Voice biometrics end to end: enroll, verify, tune, and erase","href":"/guides/voice-biometrics-enrollment-walkthrough"},{"title":"Verify a caller with KBA on a live call: challenge, answers, session gate","href":"/guides/kba-caller-verification"},{"title":"Verify OTP approvals: set up the second-officer gate","href":"/guides/verify-approvals-two-officer"},{"title":"OTP approvals workflow: run the two-officer gate end to end","href":"/guides/verify-otp-approvals-workflow"},{"title":"Verify Profiles console: create and manage verification profiles","href":"/guides/verify-configuration-console"},{"title":"Choosing a privacy primitive: OTP, WhatsApp windows, RCS fallback, or number masking","href":"/guides/number-masking-guide"},{"title":"Smart routing: preview and validate a channel before you send","href":"/guides/smart-route-preview"},{"title":"Configure route-quality thresholds and run the circuit breaker","href":"/guides/route-quality-circuit-breaker-runbook"},{"title":"Routing rules: prefix-based provider resolution","href":"/guides/routing-rules"},{"title":"Per-message cascade policy on smart-send: arm the fallback chain on the router's own pick","href":"/guides/smart-send-fallback-chains"},{"title":"Fallback chains: pick and configure channel cascades across campaigns, single messages, and OTP","href":"/guides/fallback-chains"},{"title":"Channel fallback recipe: build a two-step fallback chain you can test in sandbox","href":"/guides/fallback-channels-recipe"},{"title":"API recipe: voice broadcast with SMS fallback","href":"/guides/api-recipes/voice-sms-fallback"},{"title":"Pre-launch readiness for fallback chains","href":"/guides/campaign-fallback-readiness"},{"title":"Your first multi-channel campaign: SMS with WhatsApp fallback","href":"/guides/first-campaign-multi-channel"},{"title":"Upgrade SMS traffic to RCS per recipient","href":"/guides/sms-to-rcs-upgrade"},{"title":"SMS-pumping (AIT) protection: read the risk score before you send","href":"/guides/sms-pumping-protection"},{"title":"Composite trust \u0026 fraud risk check before a send","href":"/guides/trust-fraud-risk-composite-score"},{"title":"Sender-ID live-number testing","href":"/guides/telq-live-number-testing"},{"title":"Network signals before you send: GSMA Open Gateway and CAMARA APIs","href":"/guides/network-signals-open-gateway"},{"title":"Continuous monitoring: SIM-swap and roaming subscriptions","href":"/guides/network-apis-continuous-monitoring"},{"title":"Network APIs operator console walkthrough","href":"/guides/network-apis-operator-console"},{"title":"Rate limits: quotas, 429 backoff, and retry design","href":"/guides/rate-limits"},{"title":"Batch Safety — concurrency-tuner for SMS","href":"/guides/messages-concurrency-tuner"},{"title":"Upgrade Viber from Tier 1 to Tier 2","href":"/guides/viber-upgrade"},{"title":"Viber day one: allowlist a sender ID and send your first Tier 1 message","href":"/guides/viber-first-send-day-one"},{"title":"Voice \u0026 Messaging Pricing and Throughput","href":"/guides/voice-messaging-pricing-throughput"},{"title":"STT Playground: compare speech-to-text vendors","href":"/guides/stt-playground"},{"title":"Sync real-time shared state end to end","href":"/guides/sync-realtime-state"},{"title":"Sync Explorer console: read, write, and publish shared state from the dashboard","href":"/guides/sync-explorer-console"},{"title":"Set up and run voice queues","href":"/guides/voice-queues"},{"title":"Real-time text (RTT/TTY-TDD) accessibility on live voice calls","href":"/guides/voice-rtt-accessibility"},{"title":"Manage outbound caller IDs","href":"/guides/voice-caller-ids"},{"title":"The Caller IDs surface under Voice","href":"/guides/voice-caller-ids-surface"},{"title":"Run the Attendant Console front desk","href":"/guides/attendant-console"},{"title":"Transfer a live call: blind, warm, and queue handoffs","href":"/guides/voice-call-transfer-warm-blind-queue"},{"title":"Work the Parked Calls lobby","href":"/guides/voice-call-park-lobby"},{"title":"Hold music on held calls","href":"/guides/hold-music-manual-outbound-hold"},{"title":"Skill certifications: issue, renew, and revoke agent credentials","href":"/guides/voice-skill-certifications"},{"title":"Voice → Skill Catalog operator workflow","href":"/guides/voice-skill-catalog"},{"title":"Manage pause reason codes","href":"/guides/voice-pause-reason-codes"},{"title":"Define and use disposition tags","href":"/guides/voice-disposition-tags"},{"title":"Answer Disposition Bot: post-call labels, corrections, and QA routing","href":"/guides/voice-answer-disposition-bot"},{"title":"Paging groups","href":"/guides/paging-groups"},{"title":"Manage voice conference bridges","href":"/guides/voice-conferences"},{"title":"Ring groups end to end","href":"/guides/ring-groups"},{"title":"QA sampling: weekly evaluator sample assignment","href":"/guides/qa-sampling-settings"},{"title":"QA Evaluations: weighted scorecards, appeals, and the grading workflow","href":"/guides/quality-evaluations"},{"title":"Manage AUX codes with the break-reason taxonomy editor","href":"/guides/voice-aux-codes"},{"title":"Operate the post-call recordings pipeline: QC, legal hold, integrity seals, captions, clips, and highlights","href":"/guides/recording-lifecycle-operations"},{"title":"Redact PII and PCI from a call recording, segment by segment","href":"/guides/recording-visual-redaction"},{"title":"Voice call recordings to your own bucket (BYO storage)","href":"/guides/voice-recording-byo-storage"},{"title":"Voice call recording lifecycle: announce, egress, retention, purge","href":"/guides/voice-recording-lifecycle-runbook"},{"title":"Set up voicemail boxes and greetings","href":"/guides/voice-voicemail-boxes"},{"title":"Operate the team voicemail inbox","href":"/guides/voice-team-voicemail-inbox"},{"title":"Configure your voice preferences","href":"/guides/me-voice-preferences"},{"title":"Distinctive ringing: per-caller ring rules","href":"/guides/ring-rules"},{"title":"Voice preferences — reference","href":"/me/voice-preferences"},{"title":"Route many inbound numbers to one queue with DNIS patterns","href":"/guides/dnis-pattern-routing"},{"title":"Omnichannel queue routing for digital channels","href":"/guides/omnichannel-queue-routing"},{"title":"Pick the right inbound routing for a DID","href":"/guides/inbound-number-routing"},{"title":"Shared Line Appearance (SLA)","href":"/guides/shared-lines-appearance"},{"title":"Executive-assistant call delegation","href":"/guides/call-delegation-executive-assistant"},{"title":"Hot-desking: shared desk phones with sign-in and reservations","href":"/guides/voice-hot-desking"},{"title":"PBX operations taxonomy: shared lines, call park, ring groups, paging, hot-desking","href":"/guides/ucaas-operations-taxonomy"},{"title":"UCaaS day-two operations: run the phone system after go-live","href":"/guides/ucaas-day-two-operations"},{"title":"Build and operate an agent squad","href":"/guides/agent-squads"},{"title":"Wallboard alarm rules","href":"/guides/wallboard-alarm-rules"},{"title":"Queue SLA forecast-callback runbook","href":"/guides/queue-sla-callback-runbook"},{"title":"Per-queue analytics drilldown console","href":"/guides/queue-analytics-drilldown"},{"title":"Voice callback queue console","href":"/guides/voice-callback-console"},{"title":"Auto-schedule callbacks from wrap-up dispositions","href":"/guides/voice-disposition-callback-rules"},{"title":"Reading the Voice → Calls console: call logs, detail sheet, timeline, and analytics","href":"/guides/voice-calls-call-logs"},{"title":"Where to look first when an outbound call fails","href":"/guides/voice-call-failure-triage"},{"title":"Missed-call → SMS callback recipe","href":"/guides/missed-call-sms-callback"},{"title":"Public queue self-booking","href":"/guides/queue-appointment-booking"},{"title":"Connect a SIP trunk (BYOC): bring your own carrier or PBX to Orbit","href":"/guides/sip-trunk-connection"},{"title":"Pagination: cursor and offset paging in the Orbit API","href":"/guides/pagination"},{"title":"Sender identity onboarding map","href":"/guides/sender-identity-onboarding-map"},{"title":"Multi-region sender-identity decision walkthrough","href":"/guides/multi-region-sender-decision"},{"title":"10DLC registration for US A2P messaging compliance","href":"/guides/10dlc-registration"},{"title":"10DLC rejections, re-vetting, and the post-approval lifecycle","href":"/guides/10dlc-rejections-and-revet"},{"title":"10DLC registration wizard with save-and-resume drafts","href":"/guides/10dlc-wizard"},{"title":"Baseline compliance posture for US SMS traffic","href":"/guides/10dlc-marketing-baseline"},{"title":"Free Tool: 10DLC Throughput \u0026 Cost Calculator","href":"/guides/10dlc-throughput-calculator-tool"},{"title":"Plan campaign volume under carrier-assigned 10DLC throughput","href":"/guides/10dlc-carrier-assigned-throughput-planning"},{"title":"DLT-India onboarding for A2P SMS","href":"/guides/dlt-india-onboarding"},{"title":"Trust-tier governor: enforce carrier-assigned 10DLC throughput at send time","href":"/guides/trust-tier-governor"},{"title":"Assemble your tenant's compliance posture","href":"/guides/compliance-profiles-assemble"},{"title":"Your first compliance posture, end to end: from tenant-owned controls to a sealed evidence binder","href":"/guides/compliance-first-evidence-binder-walkthrough"},{"title":"Create a compliance profile with the wizard","href":"/guides/compliance-profile-wizard"},{"title":"ITG traceback workflow in the dashboard","href":"/guides/compliance-traceback-itg"},{"title":"Assemble your STIR/SHAKEN attestation posture","href":"/guides/stir-shaken-attestation-guide"},{"title":"Set up branded calling (RCD) end to end","href":"/guides/branded-calling-rcd-setup"},{"title":"Warm a new 10DLC number — phases, daily caps, and the 15-day ramp","href":"/guides/number-warming"},{"title":"Warm up alphanumeric and international sender IDs with the warm-up meter","href":"/guides/sender-id-warmup"},{"title":"Toll free verification","href":"/guides/toll-free-verification"},{"title":"Apply for an SMS short code","href":"/guides/short-code-application"},{"title":"Toll-free vs short code: choosing your US SMS sender","href":"/guides/us-sender-provisioning-decision"},{"title":"Messenger onboarding playbook","href":"/guides/messenger-onboarding"},{"title":"Telegram onboarding: shared test bot to your own bot","href":"/guides/telegram-onboarding"},{"title":"Instagram onboarding playbook","href":"/guides/instagram-onboarding"},{"title":"Meta comment-to-DM private replies","href":"/guides/meta-comment-to-dm"},{"title":"APAC channels onboarding: LINE and WeChat","href":"/guides/asia-channels-onboarding"},{"title":"LATAM channels onboarding: WhatsApp, SMS, and voice","href":"/guides/latam-channels-onboarding"},{"title":"MENA channels onboarding: WhatsApp and SMS","href":"/guides/mena-channels-onboarding"},{"title":"Sub-Saharan Africa channels onboarding: SMS, WhatsApp, voice","href":"/guides/sub-saharan-africa-channels-onboarding"},{"title":"South Asia and Indochina channels onboarding: SMS and WhatsApp","href":"/guides/south-asia-channels-onboarding"},{"title":"Europe channels onboarding: WhatsApp, RCS, SMS","href":"/guides/europe-channels-onboarding"},{"title":"WeChat onboarding: Official Account to template send","href":"/guides/wechat-onboarding"},{"title":"KakaoTalk production patterns: Alimtalk and Friendtalk","href":"/guides/kakao-production-patterns"},{"title":"Zalo onboarding: connect your Official Account and send ZNS templates","href":"/guides/zalo-onboarding"},{"title":"LINE onboarding: Messaging API channel to working two-way chat","href":"/guides/line-onboarding"},{"title":"Template-only Asia channels: the send playbook","href":"/guides/asia-channels-template-playbook"},{"title":"RCS onboarding: brand to launch","href":"/guides/rcs-onboarding"},{"title":"Free Tool: RCS Reach Checker","href":"/guides/rcs-reach-checker-tool"},{"title":"Send your first RCS rich message end to end","href":"/guides/first-rcs-message-send"},{"title":"RCS setup wizard: brand and first agent in one form","href":"/guides/rcs-setup-wizard"},{"title":"RCS brands console: the dashboard path","href":"/guides/rcs-brands-console"},{"title":"RCS brand walkthrough: create to first send","href":"/guides/rcs-brands-walkthrough"},{"title":"Build rich RCS cards in the visual builder","href":"/guides/rcs-rich-card-builder"},{"title":"Run an RCS marketing campaign end-to-end","href":"/guides/rcs-campaign-launch-playbook"},{"title":"Apple Messages for Business onboarding: business_id to active agent","href":"/guides/apple-messages-for-business-onboarding"},{"title":"AMB commerce: interactive flows and Apple Pay checkout","href":"/guides/apple-messages-commerce-checkout"},{"title":"Slack onboarding: connect a workspace end to end","href":"/guides/slack-onboarding"},{"title":"RCS Templates tab: approval, deliverability, and lifecycle","href":"/guides/rcs-templates-tab"},{"title":"Production go-live checklist","href":"/guides/go-live-checklist"},{"title":"Organization KYC/KYB/IDV onboarding","href":"/guides/organization-kyc-onboarding"},{"title":"RCS brand verification KYC walkthrough","href":"/guides/rcs-brand-verification-kyc"},{"title":"RCS verification corrections and screenshot retention","href":"/guides/rcs-verification-correction-and-retention"},{"title":"KYC console: business verification, document upload, and brand registration","href":"/guides/settings-kyc-console"},{"title":"Workspace general settings: identity, timezone, plan, and danger zone","href":"/guides/organization-general-settings"},{"title":"Org-wide business hours and holiday calendar defaults","href":"/guides/organization-business-hours"},{"title":"Team members, invitations, and roles","href":"/guides/organization-team-management"},{"title":"Team seat quotas: manage seats and recover from TEAM_MEMBER_CAP_REACHED","href":"/guides/team-seat-quota-operations"},{"title":"Onboarding status timeline","href":"/guides/onboarding-status-timeline"},{"title":"Onboarding wizard: tenant provisioning and white-label joins","href":"/guides/onboarding-wizard-provisioning"},{"title":"Outbound compliance pre-flight checklist","href":"/guides/send-gates-preflight-checklist"},{"title":"Read the Verifications timeline — every KYC and carrier step, its ETA, and its blocker","href":"/guides/verifications-timeline"},{"title":"Contact-center (voice/CCaaS) go-live runbook","href":"/guides/voice-ccaas-go-live-checklist"},{"title":"PSTN voice go-live checklist: numbers, identity, routing, recording, compliance","href":"/guides/voice-telephony-go-live-checklist"},{"title":"Voice go-live weekend: ship your phone system in two days","href":"/guides/voice-go-live-weekend"},{"title":"Connect first channel","href":"/guides/connect-first-channel"},{"title":"Route a first-time channel connect to the right onboarding surface","href":"/guides/connect-first-channel-multi-surface"},{"title":"Sandbox and test mode: build end to end without carrier spend","href":"/guides/sandbox-test-mode"},{"title":"Operate the Developer → Sandbox dashboard","href":"/guides/sandbox-dashboard-walkthrough"},{"title":"Developer Sandbox console","href":"/guides/sandbox-console"},{"title":"Sandbox API: worked examples — provision, fixtures, Virtual Phone, reset","href":"/guides/sandbox-api-samples"},{"title":"Call any route from every SDK: the raw-request cookbook","href":"/guides/sdk-raw-request-cookbook"},{"title":"Sandbox magic numbers playbook: one recipe for every simulated outcome","href":"/guides/sandbox-magic-numbers-playbook"},{"title":"Prefix-scoped sandbox tokens and the shared pre-launch checklist","href":"/guides/sandbox-prefix-scoped-tokens"},{"title":"Reports: generate now or schedule delivery","href":"/guides/scheduled-reports"},{"title":"Reports catalogue: the ad hoc grid and the scheduled inbox","href":"/guides/reports-catalogue"},{"title":"Monthly SLA and availability report","href":"/guides/monthly-sla-availability-report"},{"title":"Read the Reliability page","href":"/guides/settings-reliability-reading"},{"title":"Settings Status: read incident timelines and SLA attestation","href":"/guides/settings-status-console"},{"title":"Configure per-domain retention windows in Settings","href":"/guides/settings-data-retention"},{"title":"Settings: Frequency Caps Console Walkthrough","href":"/guides/settings-frequency-caps-console"},{"title":"Platform status: incident history and your shareable status page","href":"/guides/status-page"},{"title":"Email attachments: file size, MIME types, and encoding","href":"/guides/email-attachments"},{"title":"Manage uploaded files with the Media Library","href":"/guides/media-library"},{"title":"Media assets end to end: upload, tag, and use in a template","href":"/guides/media-library-cookbook"},{"title":"Email channel lifecycle: from domain verification to deliverability","href":"/guides/email-lifecycle-guide"},{"title":"Send your first transactional email","href":"/guides/first-transactional-email"},{"title":"Split transactional and marketing email into separate streams","href":"/guides/email-streams-transactional-vs-marketing"},{"title":"Isolate and throttle transactional and marketing email streams","href":"/guides/email-streams-isolate-transactional-and-marketing"},{"title":"Auto-configure sending-domain DNS on Cloudflare","href":"/guides/email-cloudflare-dns-auto-configure"},{"title":"Validate email addresses before you send","href":"/guides/email-address-validation"},{"title":"Build an email template visually: drag-and-drop blocks, variables, preview, and test sends","href":"/guides/email-visual-builder"},{"title":"Send outbound email over SMTP","href":"/guides/smtp-send-email"},{"title":"SMTP relay recipes: full request–response–error loop","href":"/guides/smtp-relay-recipes"},{"title":"Quick-action deep links","href":"/guides/quick-action-deep-links"},{"title":"API key management end to end: issue your first production key and rotate it safely","href":"/guides/api-keys-end-to-end"},{"title":"Per-API-key IP allowlist","href":"/guides/api-key-ip-allowlist"},{"title":"Per-API-key usage limits and spend alerts","href":"/guides/api-key-usage-limits"},{"title":"API rate limits \u0026 quotas console","href":"/guides/api-rate-limits-console"},{"title":"Operate migration jobs from Settings → Migrations: retry, cancel, roll back","href":"/guides/settings-migrations-console"},{"title":"API governance console","href":"/guides/developer-api-governance-console"},{"title":"API analytics dashboards (read-only)","href":"/guides/api-analytics-reader"},{"title":"Dashboard stats API","href":"/guides/stats-api-guide"},{"title":"Per-API-key usage budgets and threshold alerts","href":"/guides/api-key-usage-budget-alerts"},{"title":"Set your organization's LLM provider preference","href":"/guides/llm-provider-preference"},{"title":"BYO LLM inference credential: register, activate, rotate, revoke","href":"/guides/byo-llm-credential"},{"title":"Per-API-key spend budgets","href":"/guides/per-api-key-spend-budgets"},{"title":"Usage \u0026 delivery anomaly alert rules","href":"/guides/usage-anomaly-alert-rules"},{"title":"KPI alerts on business metrics","href":"/guides/kpi-alerts"},{"title":"Insights Alerts console operator guide","href":"/guides/insights-alerts-console-operator-guide"},{"title":"Anomaly detection — reading usage \u0026 delivery anomalies across Insights","href":"/guides/session-anomaly-alerts-reading"},{"title":"Anomaly examples — worked API samples over the anomaly-insight ledger","href":"/guides/sre-anomaly-examples"},{"title":"Usage anomalies console — reading the forensics dashboard","href":"/guides/insights-anomalies-ledger-reading"},{"title":"Public consent form: hosted unsubscribe and preferences","href":"/guides/public-consent-form"},{"title":"Orchestrate the public API surfaces","href":"/guides/public-surface-orchestration"},{"title":"Messaging Best Practices","href":"/guides/best-practices"},{"title":"Security Best Practices","href":"/guides/security"},{"title":"Security console: IP allowlist, SAML, SCIM, and 2FA","href":"/guides/settings-security-console"},{"title":"Set and rotate your dashboard password","href":"/guides/set-and-rotate-your-dashboard-password"},{"title":"Manage media quarantines and upload policy in Settings → Media","href":"/guides/settings-media-console"},{"title":"Work a suppression entry in Settings → Message Suppression (and the two consoles it borders)","href":"/guides/settings-message-suppression-console"},{"title":"Author a keyword rule in Settings → Keyword Rules (end-to-end walkthrough)","href":"/guides/settings-keyword-rules-console"},{"title":"Configure campaign defaults and send-gate preflight in Settings → Campaigns","href":"/guides/settings-campaigns-console"},{"title":"Settings → Custom Fields console","href":"/guides/settings-custom-fields-console"},{"title":"Settings → QA Autoscore console: readiness panel, calibration, and rule thresholds","href":"/guides/settings-qa-autoscore-console"},{"title":"Voice Settings Consoles","href":"/guides/channel-settings-consoles"},{"title":"Voice Agent channel toggles walkthrough","href":"/guides/channel-voice-agent-toggles"},{"title":"Branding console: logo, colors, and custom domain","href":"/guides/branding-console-white-label"},{"title":"Audit Log","href":"/guides/audit-log"},{"title":"Audit Log Export","href":"/guides/audit-log-export"},{"title":"Tenant migrations: find drift, re-run safely, resolve failures","href":"/guides/tenant-migration-ops"},{"title":"Presence federation: Teams, Slack, Webex, Zoom, and calendar availability","href":"/guides/presence-federation-settings"},{"title":"Colleagues directory: live presence and click-to-call","href":"/guides/voice-colleagues-directory"},{"title":"Import or migrate contacts: pick the right surface, in the right order","href":"/guides/import-and-migrate-contacts"},{"title":"Run a migration from Settings → Migrations: the full operator walkthrough","href":"/guides/audience-migrations-console"},{"title":"Migration playbook hub: the vendor-agnostic sequence for any source platform","href":"/guides/migration-playbook-hub"},{"title":"Migrate from Twilio to Orbit: SMS, voice, and webhooks","href":"/guides/migration-from-twilio"},{"title":"Migrate from Telnyx to Orbit: SMS, MMS, voice, fax, and webhooks","href":"/guides/migration-from-telnyx"},{"title":"Migrate from Sinch to Orbit: SMS, Conversation API, and Verification","href":"/guides/migration-from-sinch"},{"title":"Migrate from MessageBird (Bird) to Orbit: SMS, Flows, and WhatsApp","href":"/guides/migration-from-messagebird"},{"title":"Migrate from Vonage to Orbit: SMS, voice, and webhooks","href":"/guides/migration-from-vonage"},{"title":"Migrate from Infobip to Orbit: SMS, WhatsApp, and number lookup","href":"/guides/migration-from-infobip"},{"title":"Migrate from Klaviyo to Orbit: CDP profiles, events, segments, and journeys","href":"/guides/migration-from-klaviyo"},{"title":"Migrate consent registers and opt-out lists to Orbit","href":"/guides/compliance-consent-migration"},{"title":"Assisted import from Klaviyo, MessageBird, or Telnyx: the onboarding wizard walkthrough","href":"/guides/assisted-import-wizard"},{"title":"Migrate from enterprise CCaaS (Genesys, Talkdesk, Five9, NICE CXone)","href":"/guides/migrate-from-enterprise-ccaas"},{"title":"Migrate from Salesforce to Orbit: reconnect, or run both","href":"/guides/crm-migration-salesforce"},{"title":"Migrate from HubSpot to Orbit: reconnect, or run both","href":"/guides/crm-migration-hubspot"},{"title":"Migrate from Zendesk to Orbit: tickets, users, and knowledge","href":"/guides/crm-migration-zendesk"},{"title":"Run a platform migration end-to-end: wizard, Migrations page, cancel, rollback","href":"/guides/platform-migration-jobs"},{"title":"Monitor, cancel, and roll back platform migrations from Settings → Migrations","href":"/guides/migration-jobs-operations"},{"title":"Porting numbers end-to-end: preflight, LOA, FOC, and bulk CSV","href":"/guides/port-numbers"},{"title":"Port numbers out safely: PIN protection, FOC tracking, and cancellation","href":"/guides/port-out-numbers"},{"title":"Your first port-in: a do-it-right walkthrough (LOA, PIN, and FOC tracking)","href":"/guides/number-porting-walkthrough-first-port"},{"title":"Batch port-in: multi-number lifecycle for one shipment","href":"/guides/port-numbers-batch-walkthrough"},{"title":"FAQ: porting and numbers","href":"/guides/faq-porting-and-numbers"},{"title":"Text-enable a number with hosted messaging","href":"/guides/hosted-messaging"},{"title":"Buy and provision numbers: single purchases, bulk orders, and post-purchase wiring","href":"/guides/buy-numbers"},{"title":"Announcements hub: the provisioning-capability inventory behind Numbers → Buy","href":"/guides/hub-announcements-provisioning"},{"title":"Bulk Reserve in the console: reserve, hold, and finalize up to 1000 DIDs","href":"/guides/bulk-reserve"},{"title":"Bulk number-order history: the delivered/partial/failed ledger","href":"/guides/numbers-bulk-orders-history"},{"title":"Bulk number-order recovery: decode failed lines to the remediation","href":"/guides/numbers-bulk-order-recovery-runbook"},{"title":"Inbound health: find and repair numbers that silently drop inbound SMS","href":"/guides/numbers-inbound-resolution-health"},{"title":"Number applications: bind DID inbound routing to IVR, webhook, or SIP targets","href":"/guides/number-applications"},{"title":"Order international freephone numbers end to end","href":"/guides/international-freephone"},{"title":"Assign and reassign numbers: who owns what, one workflow","href":"/guides/number-assignments"},{"title":"Mask two parties' numbers with a proxy session: create, route, terminate, and verify","href":"/guides/number-masking-privacy-sessions"},{"title":"Call tracking \u0026 dynamic number insertion (DNI)","href":"/guides/call-tracking-dni"},{"title":"Dynamic number pools (tracking pools) end-to-end","href":"/guides/tracking-pools-dni"},{"title":"Evaluating alternatives","href":"/alternatives/index"},{"title":"Evaluating call-tracking alternatives","href":"/alternatives/call-tracking-evaluation"},{"title":"Evaluating enterprise messaging + voice alternatives","href":"/alternatives/enterprise-messaging-voice-evaluation"},{"title":"Evaluating omnichannel CPaaS alternatives","href":"/alternatives/omnichannel-cpaas-evaluation"},{"title":"Evaluating contact center (CCaaS) alternatives","href":"/alternatives/contact-center-evaluation"},{"title":"Evaluating secure-messaging alternatives","href":"/alternatives/secure-messaging-evaluation"},{"title":"Evaluating carrier models","href":"/alternatives/carrier-model-evaluation"},{"title":"Evaluating caller-identity alternatives","href":"/alternatives/caller-identity-evaluation"},{"title":"Retail notifiable events: SMS vs WhatsApp","href":"/alternatives/notifiable-events-comparison"},{"title":"Evaluating voice-routing DSL ownership","href":"/alternatives/voice-dsl-evaluation"},{"title":"Connect a SIP trunk end to end: register, route, test, monitor","href":"/guides/sip-trunk-setup"},{"title":"Register your PBX on Devotel Orbit: outgoing trunk, transports, and registration health","href":"/guides/registering-your-pbx-on-orbit"},{"title":"SIP trunk first call: the agreement-to-confirmation walkthrough","href":"/guides/sip-trunk-first-call-walkthrough"},{"title":"E911 emergency drill mode: test your dial plan with 933","href":"/guides/e911-emergency-drill"},{"title":"On-site 911 notifications: configure Kari's Law safety alerts","href":"/guides/voice-emergency-notification-karis-law"},{"title":"AI Voice Agents via sip_forward (callers.ai, Retell, Vapi)","href":"/guides/ai-voice-agent-sip-forward"},{"title":"Connect your first AI agent to a phone number","href":"/guides/first-ai-voice-agent-phone-call"},{"title":"Hear your first AI voice agent call with zero spend","href":"/guides/first-voice-agent-test-call-zero-spend"},{"title":"Live-human overflow for AI voice-agent campaigns","href":"/guides/outbound-live-human-overflow"},{"title":"AI-voice warm handoff to a human agent","href":"/guides/voice-ai-handoff-to-human"},{"title":"Read the outbound voice country-coverage matrix","href":"/guides/voice-country-coverage"},{"title":"Enroll Voice Clones from Calls","href":"/guides/voice-clones"},{"title":"Build a WhatsApp and SMS AI Agent","href":"/guides/whatsapp-sms-ai-agent"},{"title":"Ambient agents: proactive outreach from setup to audit","href":"/guides/agent-ambient-outreach"},{"title":"Safely Roll Out an AI Agent","href":"/guides/ai-agent-rollout-pipeline"},{"title":"Generate an Agent Conformity Dossier","href":"/guides/agent-conformity-dossier-walkthrough"},{"title":"Detect and Handle Conversation Loops in AI Agents","href":"/guides/agent-loop-detector"},{"title":"Agent evals: datasets, runs, and pass-rate gates","href":"/guides/agent-evals-datasets-loop"},{"title":"Promote production traces into eval datasets","href":"/guides/agent-trace-to-dataset"},{"title":"Agent prompt A/B experiments: lift, holdout, and attribution","href":"/guides/agent-experiments-ab-prompts"},{"title":"Author an AI Agent from a Prompt","href":"/guides/agent-from-prompt"},{"title":"Stream an Agent Response Token-by-Token over SSE","href":"/guides/agent-sse-token-streaming"},{"title":"Build Agents Visually in the Agent Studio Canvas","href":"/guides/agent-studio-canvas"},{"title":"Tune the semantic response cache: enablement, threshold, and TTL from your traffic","href":"/guides/agent-semantic-response-cache-tuning"},{"title":"Register BYO MCP servers in the console","href":"/guides/agents-byob-mcp-console"},{"title":"Build tenant custom tools for AI agents","href":"/guides/agents-custom-tools"},{"title":"Pick a voice-agent model preset","href":"/guides/agents-model-presets"},{"title":"Agents Prompt Template Library","href":"/guides/agents-prompt-template-library"},{"title":"Browse and deploy voice agent templates","href":"/guides/voice-agent-templates"},{"title":"Timed pauses and expressive audio cues in voice prompts","href":"/guides/voice-prompt-delivery-cues"},{"title":"Customer Memory: inspect and curate what your AI agents remember","href":"/guides/customer-memory"},{"title":"Agents memory console: browse, teach, and audit per-agent memory","href":"/guides/agents-memory"},{"title":"AI Hub memory page walkthrough: namespaces, entries, and tenant caps","href":"/guides/ai-memory"},{"title":"Async batch inference for AI agents","href":"/guides/agents-batch-inference"},{"title":"Tune AI-Agent Guardrails with Analytics","href":"/guides/guardrail-analytics-tuning"},{"title":"Read Guardrail Analytics per Policy","href":"/guides/guardrail-analytics-per-policy-reading"},{"title":"Author custom guardrail rules with the deterministic DSL","href":"/guides/custom-guardrail-dsl"},{"title":"Supervise pending tool approvals before they run","href":"/guides/agent-tool-approvals"},{"title":"Debug a single agent conversation turn by turn","href":"/guides/agent-conversation-debug"},{"title":"Build and Maintain an AI Knowledge Base","href":"/guides/knowledge-base-lifecycle"},{"title":"Continue a conversation on another channel","href":"/guides/continue-conversation-across-channels"},{"title":"On-call escalation stack: which guide to open first","href":"/guides/oncall-escalation-stack"},{"title":"Build on-call alerting with the On-Call API","href":"/guides/oncall-alerting"},{"title":"On-call roster \u0026 escalation policy runbook","href":"/guides/oncall-escalation-runbook"},{"title":"On-call deep dive: from dashboard hub to a working pager","href":"/guides/oncall-deep-dive"},{"title":"Triage the Notification Center","href":"/guides/in-dashboard-notifications"},{"title":"Navigate the dashboard Home page","href":"/guides/dashboard-home-overview"},{"title":"Read the dashboard Home page","href":"/guides/dashboard-home"},{"title":"Read the channel health widget","href":"/guides/dashboard-channel-health"},{"title":"Dashboard fallback guards","href":"/guides/dashboard-home-defensive-fallbacks"},{"title":"Read and filter the notifications feed","href":"/guides/notifications-feed"},{"title":"Configure notification channels","href":"/guides/notifications-settings"},{"title":"Configure and run the Email Digest admin console","href":"/guides/email-digest-admin"},{"title":"Connect HubSpot \u0026 Salesforce end to end","href":"/guides/hubspot-salesforce-integration"},{"title":"Salesforce Service Cloud Operator Guide: Communications Layer Decision","href":"/guides/salesforce-service-cloud-operator-guide"},{"title":"Connect Pipedrive: CRM context in the inbox, activities written back","href":"/guides/pipedrive-integration"},{"title":"Connect Intercom: inbound threads in the Orbit inbox, writeback to Intercom","href":"/guides/intercom-integration"},{"title":"Connect Shopify: events, cart recovery, and order records in one walkthrough","href":"/guides/shopify-integration"},{"title":"Build an abandoned-cart recovery flow","href":"/guides/abandoned-cart-recovery-flow"},{"title":"Build a failed-payment recovery ladder","href":"/guides/dunning-failed-payment-recovery-tutorial"},{"title":"Connect the SaaS integrations: OAuth popup and API-key credential form","href":"/guides/oauth-saas-integrations"},{"title":"Connect Google Workspace and Microsoft 365: calendars, contacts, and mail for CRM and agent tools","href":"/guides/google-workspace-microsoft-365-integration"},{"title":"Connect Segment to Orbit: CDP ingest end to end","href":"/guides/segment-integration"},{"title":"Connect WooCommerce: REST key pair, order events, and cart recovery","href":"/guides/woocommerce-integration"},{"title":"Connect Zendesk, Jira, Calendly, DocuSign, Slack, Zapier, and n8n","href":"/guides/integrations-zendesk-jira-calendly-docusign-slack-zapier-n8n"},{"title":"Calendly integration: booking events, SMS confirmations, and the HMAC receiver","href":"/guides/calendly-integration"},{"title":"Delivery log","href":"/guides/delivery-log"},{"title":"DLR outcomes monitoring — reading the WARN classification","href":"/guides/dlr-outcomes-monitoring"},{"title":"Read the Insights dashboards","href":"/guides/insights-dashboards"},{"title":"Read the consolidated deliverability dashboard","href":"/guides/insights-deliverability-reading"},{"title":"Read the Channel costs page","href":"/guides/insights-costs"},{"title":"Insights → Analytics console","href":"/guides/insights-analytics-realtime"},{"title":"Order notifications ledger — read your transactional commerce sends","href":"/guides/order-notifications-ledger"},{"title":"Reading machine-sent transactional traffic in the ledger","href":"/guides/transactional-ledger-reading"},{"title":"Order dispatch notifications workflow: stage events → templated sends → ledger lineage","href":"/guides/order-dispatch-notifications-workflow"},{"title":"Logs: the real-time event log viewer","href":"/guides/insights-logs-viewer"},{"title":"Cohort retention: read the curve and the heatmap","href":"/guides/insights-cohort-retention"},{"title":"Build conversion funnels and retention grids over CDP events","href":"/guides/insights-funnels-cdp-conversion"},{"title":"Read the Insights dashboards as one decision picture","href":"/guides/insights-agent-comparison-cohort-loop"},{"title":"Marketing mix model — split a budget across channels from spend and revenue history","href":"/guides/insights-media-mix-model"},{"title":"Read the Topic Intelligence dashboard","href":"/guides/insights-topic-intelligence"},{"title":"Read the Sales Conversation Intelligence surface","href":"/guides/insights-sales-conversation-intelligence"},{"title":"Read the Conversation Intelligence panel","href":"/guides/conversation-intelligence"},{"title":"Manual conversation-intelligence re-run for inbox threads","href":"/guides/conversation-intelligence-re-run"},{"title":"Compare AI agents with percentile benchmarks","href":"/guides/agent-comparison"},{"title":"Fleet triage playbook: map six agent anomalies to their debug surfaces","href":"/guides/agent-fleet-debugging-playbook"},{"title":"Plan per-agent channel concurrency caps","href":"/guides/agent-channel-concurrency-caps"},{"title":"Build a custom Insights dashboard","href":"/guides/insights-dashboard-builder"},{"title":"Ask your data — natural-language questions on Analytics","href":"/guides/ask-your-data-insights"},{"title":"Score AI-agent quality per language","href":"/guides/language-quality"},{"title":"Auto-draft help articles from resolved conversations","href":"/guides/kb-auto-draft"},{"title":"Knowledge Base Document Versioning and Rollback","href":"/guides/knowledge-base-versioning-and-rollback"},{"title":"Inspect grounding citations on an AI agent","href":"/guides/agent-grounding-citations"},{"title":"Mine deflection gaps into knowledge base additions","href":"/guides/knowledge-gap-miner"},{"title":"Close knowledge-base deflection gaps","href":"/guides/kb-deflection-gaps"},{"title":"Mine automation opportunities into draft agents and flows","href":"/guides/automation-opportunity-miner"},{"title":"Understand and use Contact reasons","href":"/guides/contact-reasons"},{"title":"Read the sentiment portfolio dashboard","href":"/guides/sentiment-portfolio-reading"},{"title":"Read the Voice → Intelligence page","href":"/guides/voice-intelligence-trends"},{"title":"Read the Voice Agent Quality Index (VAQI)","href":"/guides/voice-agent-quality-vaqi"},{"title":"Read the Voice Quality surface","href":"/guides/voice-quality-reading"},{"title":"Queue-level AI ops digest","href":"/guides/queue-ai-ops-digest"},{"title":"Read the cost-intelligence dashboards","href":"/guides/cost-intelligence"},{"title":"Read the unified cost-economics roll-up","href":"/guides/cost-economics-insights"},{"title":"Read the LLM spend dashboard","href":"/guides/insights-llm-spend"},{"title":"Search message history","href":"/guides/search-message-history"},{"title":"Interactions console","href":"/interactions/overview"},{"title":"Interaction Search access and CSV export","href":"/guides/interactions-export-auth-model"},{"title":"Read Search Analytics — top queries, zero-result, click-through","href":"/guides/search-analytics-reading"},{"title":"Search every conversation and call in one list","href":"/guides/interaction-search"},{"title":"Interaction Search deep dive","href":"/guides/interaction-search-deep-dive"},{"title":"Find a conversation across channels with Interaction Search","href":"/guides/interactions-find-a-conversation"},{"title":"Walk the Interactions console","href":"/guides/interactions-console"},{"title":"Interactions hub — workflows for support leads","href":"/guides/interactions-hub"},{"title":"Recover a stuck customer order across Interactions, the thread, and Customer 360","href":"/guides/interactions-stuck-order-case"},{"title":"Read Journey Paths — cross-channel steps and drop-off","href":"/guides/journey-paths-reading"},{"title":"Read and export the unified contact timeline","href":"/guides/contact-timeline"},{"title":"Conversation archive: natural-language search and filtered export","href":"/guides/conversation-archive"},{"title":"Export conversations as signed IETF vCon containers","href":"/guides/conversation-export-vcon"},{"title":"Import conversations from signed IETF vCon containers","href":"/guides/conversation-import-vcon"},{"title":"Surveys end to end: distribute, remind non-responders, results, benchmark","href":"/guides/surveys-voc"},{"title":"Post-call CSAT and NPS surveys: IVR digit capture, agent rollup","href":"/guides/post-call-surveys"},{"title":"Survey scorecards: queue- and agent-level CSAT/NPS rollups","href":"/guides/voice-survey-scorecards"},{"title":"Auto-CSAT/NPS dispatch: close-triggered surveys, queue and agent scorecards","href":"/guides/auto-csat-nps"},{"title":"Auto-NPS console: a dedicated Settings → NPS page for the loyalty track","href":"/guides/auto-nps-settings"},{"title":"CSAT and NPS settings consoles: dispatch controls, detractor rescue, read paths","href":"/guides/settings-liveops-csat-nps"},{"title":"A/B test a campaign: variants, splits, and picking a winner","href":"/guides/campaign-ab-testing"},{"title":"Smart-send timing playbook: per-contact schedules, send-time experiments, and next-best-channel","href":"/guides/campaign-smart-send-timing-playbook"},{"title":"Adaptive send-pacing: DLR-feedback rate control for campaigns","href":"/guides/adaptive-pacing"},{"title":"Send a campaign end-to-end: draft, audience, dry-run, launch, analytics","href":"/guides/campaign-end-to-end"},{"title":"Grow an SMS list: opt-in capture, 10DLC, first campaign","href":"/guides/sms-list-growth-funnel"},{"title":"Preflight review of a campaign audience with the preview endpoint","tag":"outbound","href":"/guides/campaign-audience-preflight-review"},{"title":"Build a blast or drip campaign with the create wizard","href":"/guides/campaign-create-wizard"},{"title":"Campaign template + variable personalization walkthrough: creative → channel → slots → A/B → pre-flight","href":"/guides/campaign-template-variable-personalization-walkthrough"},{"title":"Auto-localize a template into per-locale carrier-approved variants","href":"/guides/template-auto-localization"},{"title":"Outbound audiences console: pick, attach, and gate audiences for campaigns","tag":"outbound","href":"/guides/outbound-audiences-console"},{"title":"Build, simulate, and launch a campaign journey (canvas, nodes, goals)","href":"/guides/campaign-journey-builder"},{"title":"Author a campaign journey from a natural-language prompt","href":"/guides/campaign-journey-from-prompt"},{"title":"Deliverability Lab: lint filtering risk and predict per-carrier delivery before you send","href":"/guides/campaign-deliverability-lab"},{"title":"Receiver-side deliverability: fold DMARC RUA reports and Postmaster reputation into your panel","href":"/guides/email-dmarc-rua-and-receiver-reputation-loop"},{"title":"Holdouts and lift: measure what a campaign (or its send-time optimization) actually caused","href":"/guides/campaign-holdout-uplift-measurement"},{"title":"Win-back lapsed customers with a multi-channel fallback journey","href":"/guides/winback-journey-with-fallback-channels"},{"title":"Validate campaign personalization merge-tags before launch","href":"/guides/campaign-personalization-preview"},{"title":"CSV to launched SMS blast: the operator path end to end","href":"/guides/csv-to-launched-sms-blast"},{"title":"Outbound AI Studio: brief-to-draft, variant generator, and winner insights","href":"/guides/outbound-ai-studio"},{"title":"Short links with click tracking and campaign attribution","href":"/guides/short-links-and-click-tracking"},{"title":"Connect a custom domain for short links","href":"/guides/connect-custom-short-link-domain"},{"title":"Short links cookbook: mint, send, measure, react","href":"/guides/short-links-cookbook"},{"title":"Link tracking analytics API samples","href":"/guides/link-tracking-api-samples"},{"title":"Reading link tracking analytics (Insights → Link tracking)","href":"/guides/link-tracking-analytics"},{"title":"Reading the SMS click-through parity panel","href":"/guides/sms-click-through-parity"},{"title":"Reading the SMS click-through rollup (Insights → SMS click-through)","href":"/guides/insights-sms-ctr"},{"title":"Insights hub","href":"/insights/overview"},{"title":"Hub map","href":"/insights/hub-map"},{"title":"Insights console map: the KPI surface, filters, and gauge semantics per tile","href":"/insights/console-map"},{"title":"SMS click-through","href":"/insights/sms-ctr"},{"title":"Usage alert rules on the Insights surface","href":"/guides/insights-usage-alert-rules"},{"title":"Campaign analytics: reading the /campaigns/[id] panels","href":"/insights/campaign-analytics"},{"title":"Landing pages: build, publish, and attribute","href":"/guides/landing-pages"},{"title":"Read campaign ROAS and revenue attribution","href":"/guides/campaign-roas-attribution"},{"title":"Campaign ROI bulk export","href":"/guides/campaign-roi-summary-export"},{"title":"Multi-touch attribution: split conversion credit across channels","href":"/guides/multi-touch-attribution"},{"title":"Defining and reading Conversion Goals (Insights → Goals)","href":"/guides/conversion-goals-attribution"},{"title":"Conversions and attribution across channels — the overview","href":"/guides/conversions-and-attribution-overview"},{"title":"Read the click-to-chat attribution funnel","href":"/guides/attribution-funnel-changelog"},{"title":"Marketing Mix Model: split your budget across channels","href":"/guides/marketing-mix-model"},{"title":"Template analytics: measure performance across campaigns","href":"/guides/template-analytics"},{"title":"Outbound templates: author, manage, and reuse message bodies","href":"/guides/outbound-templates"},{"title":"Template-variable catalogue — what the picker consumes","href":"/guides/campaigns-template-variable-catalogue"},{"title":"Ads hub: first Meta connect, first attributed lead","href":"/guides/ads-hub-overview"},{"title":"Meta Ads: segment to campaign to attribution","href":"/guides/ads-activation"},{"title":"Ads console walkthrough: connect, campaign, CAPI, attribution","href":"/guides/ads-console"},{"title":"Your first attributed lead, end to end","href":"/guides/ads-first-attributed-lead-walkthrough"},{"title":"Ads: scope and feature boundaries","href":"/guides/ads-scope"},{"title":"Ads hub reference","href":"/ads/overview"},{"title":"Referral programs: create a program, issue codes, track conversions, and pay rewards","href":"/guides/referral-programs"},{"title":"Referral programs: issuance, attribution, leaderboard, and edge cases","href":"/guides/referral-programs-deep-dive"},{"title":"Set up a referral campaign from the dashboard, step by step","href":"/guides/referrals-campaign-setup"},{"title":"The referral conversion loop: clicks, conversions, leaderboard, and payouts","href":"/guides/referral-conversion-loop"},{"title":"Loyalty program setup: points, tiers, and redemption","href":"/guides/loyalty-program"},{"title":"Outbound loyalty: points, tiers, and member balances","href":"/concepts/outbound-loyalty"},{"title":"Run the incentives ledger: promos and support credits","href":"/guides/incentives-ledger"},{"title":"Orchestrate a product launch across loyalty, wallet passes, referrals, and incentives","href":"/guides/marketing-product-launch-campaign"},{"title":"Launch an outbound dialer campaign: pacing, lists, dispositions, callbacks","href":"/guides/outbound-dialer-campaign"},{"title":"Run an outbound dialer campaign live: console widgets, pause/abort, callbacks","href":"/guides/dialer-live-console"},{"title":"Work a dialer campaign from the agent view: next-contact, click-to-call, dispositions","href":"/guides/dialer-agent-console"},{"title":"Best-time-to-dial: enroll each contact for the window they're most likely to answer","href":"/guides/best-time-to-dial"},{"title":"Turn on AMD and voicemail drop on a dialer campaign","href":"/guides/dialer-amd-and-voicemail-drop"},{"title":"Read the per-campaign dialer sentiment \u0026 outcome card","href":"/guides/dialer-sentiment-card"},{"title":"Validate caller-ID coverage before launching a campaign","href":"/guides/caller-id-coverage-validation"},{"title":"Outbound goals, approvals, and direct send","href":"/guides/outbound-goals-approvals-direct-send"},{"title":"Campaign approvals","href":"/guides/outbound-approvals"},{"title":"Direct send: one-off messages, batch or single","href":"/guides/outbound-direct-send"},{"title":"Direct send recipe: one message to one contact, no campaign","href":"/guides/outbound-direct-send-recipe"},{"title":"Run a voice broadcast end to end","href":"/guides/voice-broadcasts"},{"title":"Voice broadcast with SMS fallback, threaded back into the Inbox","href":"/guides/voice-broadcast-with-sms-fallback"},{"title":"Set up a voice broadcast with SMS fallback and per-recipient delivery tracking","href":"/guides/outbound-voice-broadcast-with-sms-fallback-setup"},{"title":"Emergency mass notification for campuses: a decision-to-live walkthrough","href":"/guides/emergency-mass-notification-campus-walkthrough"},{"title":"Customer alerts and wallet engagement for digital banks: an end-to-end walkthrough","href":"/guides/fintech-account-alerts-walkthrough"},{"title":"Utilities outage and usage notifications: an end-to-end walkthrough","href":"/guides/utilities-outage-usage-walkthrough"},{"title":"Public-sector civic services: an end-to-end walkthrough","href":"/guides/public-sector-civic-services-walkthrough"},{"title":"Build the guest journey for travel and hospitality","href":"/guides/travel-hospitality-guest-journey-walkthrough"},{"title":"Issue and deliver a wallet pass end to end","href":"/guides/wallet-passes"},{"title":"Marketing hub overview: referrals, loyalty, incentives, and wallet passes","href":"/marketing/overview"},{"title":"Referrals console reference","href":"/marketing/referrals"},{"title":"Loyalty console reference","href":"/marketing/loyalty"},{"title":"Incentives console reference","href":"/marketing/incentives"},{"title":"Wallet Passes console reference","href":"/marketing/wallet-passes"},{"title":"Marketing hub console map — wallet passes, loyalty, and referrals in one place","href":"/guides/marketing-hub-consoles"},{"title":"Messages hub orientation — the tile map for every channel console","href":"/guides/messages-hub-orientation"},{"title":"Outbound hub orientation — every tile and where it lands","href":"/guides/outbound-hub-orientation"},{"title":"Outbound campaigns canonical entry","href":"/guides/outbound-campaigns-canonical-entry"},{"title":"Audience hub console map — contacts, segments, and every identity you send from","href":"/guides/audience-hub-orientation"},{"title":"Voice hub orientation — the tile map for the voice desk","href":"/guides/voice-hub-orientation"},{"title":"Sustainability and ESG reporting","href":"/guides/sustainability-esg-reporting"},{"title":"Click-to-chat QR codes for print and web","href":"/guides/qr-codes"},{"title":"Build and ship your first IVR flow","href":"/guides/build-ivr-flow"},{"title":"Make your first outbound PSTN call: SIP trunk or browser softphone","href":"/guides/first-outbound-voice-call"},{"title":"Program an outbound voice call: answer_url, verbs, and transcript","href":"/guides/programmable-voice-call"},{"title":"Ivr visual builder","href":"/guides/ivr-visual-builder"},{"title":"Pick your IVR surface: canvas or DSL","href":"/guides/ivr-builder-canvas-vs-dsl-walkthrough"},{"title":"First IVR via the Visual Builder canvas","href":"/guides/ivr-visual-builder-first-flow"},{"title":"Unattended PCI capture in the IVR builder","href":"/guides/ivr-secure-payment-capture"},{"title":"Build an IVR flow with NLU intent routing","href":"/guides/ivr-routing-nlu"},{"title":"Collect structured intake in an IVR with slot-filling","href":"/guides/ivr-slot-filling-intake"},{"title":"Tutorial: the IVR-to-agent escalation ladder, validated on real caller audio","href":"/guides/ivr-to-agent-escalation-stt-tuning-tutorial"},{"title":"Flow versions and publishing lifecycle","href":"/guides/flow-versions-and-publishing"},{"title":"Flows as code: author flow JSON in your repo, publish in CI","href":"/guides/flows-as-code-publish-pipeline"},{"title":"First IVR via the first-flow wizard","href":"/guides/first-ivr-wizard"},{"title":"Build your first automation flow","href":"/guides/build-first-flow"},{"title":"Five flow recipes: welcome series, reminders, support triage, surveys, order updates","href":"/guides/flows-recipes"},{"title":"Functions node recipes: normalize, hash, map, compute, and shape payloads in a flow","href":"/guides/flows-transform-node-recipes"},{"title":"Build an interactive USSD flow end to end","href":"/guides/ussd-flow-builder"},{"title":"Build and test USSD menus from the Numbers hub","href":"/guides/numbers-ussd-menu-editor"},{"title":"Send USSD push (network-initiated) sessions end to end","href":"/guides/ussd-push-sessions"},{"title":"Build USSD menus end to end — session model to production","href":"/guides/ussd-flows-cookbook"},{"title":"Commerce hub overview","href":"/guides/commerce-hub-overview"},{"title":"Run a loyalty and rewards program end to end","href":"/guides/loyalty-rewards-program-end-to-end"},{"title":"Conversational Commerce Checkout","href":"/guides/conversational-commerce-checkout"},{"title":"Conversational Commerce Rails","href":"/guides/conversational-commerce-rails"},{"title":"Commerce Hub: Carrier Billing \u0026 Pay Links","href":"/guides/commerce-dcb-and-pay-links"},{"title":"Commerce hub: mandates, subscriptions, AI storefront","href":"/guides/commerce-subscriptions-storefront-mandates"},{"title":"A2A agentic-commerce transact skill","href":"/guides/agentic-commerce-transact"},{"title":"Simulcast a webinar with RTMP egress","href":"/guides/video-rtmp-egress-simulcast"},{"title":"Your first video meeting in 10 minutes","href":"/guides/first-video-meeting-10-min"},{"title":"Agent hardening runs: regression, red-team, and soak","href":"/guides/agent-redteam-regression-soak"},{"title":"Run a simulive webinar (pre-recorded video, played as live)","href":"/guides/video-simulive-webinar"},{"title":"Organization KYC end to end: verify the business, lift the WhatsApp cap, issue RCS brand verification","href":"/guides/organization-kyc-end-to-end"},{"title":"Last-mile logistics notifications with driver privacy","href":"/guides/logistics-last-mile-playbook"}]},{"group":"Messaging Controls","pages":[{"title":"Frequency caps: per-contact rolling send limits","href":"/guides/frequency-caps"},{"title":"Campaign limits: audience-cap override and default quiet-hours window","href":"/guides/campaign-limits-quiet-hours"},{"title":"Per-campaign quiet hours: override the window on a campaign row","href":"/guides/per-campaign-quiet-hours"},{"title":"Message suppression: block duplicate message sends","href":"/guides/message-suppression"},{"title":"Auto-reply rules: answer inbound keywords automatically","href":"/guides/keyword-auto-reply-rules"},{"title":"Keyword auto-reply worked examples: match types, opt-outs, and precedence in action","href":"/guides/keyword-rules-recipes"},{"title":"Route inbound SMS with priority-ordered rules","href":"/guides/inbound-sms-routing"},{"title":"Route inbound messages with routing rules","href":"/guides/messages-inbound-routes"},{"title":"Quiet hours: org-wide channel gates vs. the campaign fallback window","href":"/guides/quiet-hours-configuration"},{"title":"Quiet-Hours Preview: Channel-by-Channel Semantics","href":"/compliance/quiet-hours-preview"},{"title":"Set up the pre-send policy scanner and DLP rules","href":"/guides/policy-scanner-dlp-setup"},{"title":"TCPA Posture Across SMS and Voice","href":"/guides/tcpa-quiet-hours-and-windows"},{"title":"TCPA quiet-hours window checker tool walkthrough","href":"/guides/quiet-hours-checker-tool"},{"title":"Free Tool: TCPA Compliance Checklist","href":"/guides/tcpa-compliance-checklist-tool"},{"title":"Free Tool: GDPR/DSAR Readiness Checklist","href":"/guides/gdpr-dsar-checklist-tool"},{"title":"Free Tool: Carrier \u0026 Line-Type Lookup Checker","href":"/guides/carrier-line-type-lookup-tool"},{"title":"Free Tool: E.164 Phone Formatter \u0026 Validator","href":"/guides/e164-formatter-tool"},{"title":"Free Tool: SMS Segment \u0026 Cost Calculator","href":"/guides/sms-calculator-tool"},{"title":"SMS CSV export column reference","href":"/guides/messages-export-columns-vs-csv"},{"title":"Quiet hours across DST: crossover nights, Arizona and Hawaii, and the pre-launch preview","href":"/guides/quiet-hours-dst-crossover"},{"title":"Schedule one-off sends across channels with scheduled_at","href":"/guides/message-scheduling"},{"title":"Send-window optimization with send_at_type","href":"/guides/message-scheduling-send-window-optimization"},{"title":"Messages scheduled console","href":"/guides/messages-scheduled-console"},{"title":"Scheduled messages: Twilio parity recipes","href":"/guides/scheduled-messages-twilio-parity-recipes"},{"title":"Appointment reminders end to end: schedule, confirm, fall back, and verify","href":"/guides/appointment-reminders-workflow"},{"title":"Custom Opt-Out Keyword Lists","href":"/guides/opt-out-lists"},{"title":"SMS opt-out \u0026 opt-in rules","href":"/guides/opt-out-rules"},{"title":"Messages Blocklist: block specific outbound destinations","href":"/guides/messages-blocklist"},{"title":"Sender pools: rotate outbound numbers and sender IDs","href":"/guides/sender-pools"},{"title":"Read and respond to SMS spam-complaint (FBL) thresholds","href":"/guides/sms-complaint-response"},{"title":"Bulk feedback import: post MMP attribution outcomes back to messages","href":"/guides/message-feedback-bulk-import"},{"title":"Walkthrough: import message feedback outcomes in bulk","href":"/guides/messages-feedback-bulk-import-walkthrough"},{"title":"Messages batch sms","href":"/guides/messages-batch-sms"},{"title":"Batch SMS: AI-assisted drafting and rewrites","href":"/guides/messages-batch-sms-ai-assist"},{"title":"Batch SMS: the Insert variable picker, resolved preview, and unresolved-variable gate","href":"/guides/messages-batch-sms-variable-picker"},{"title":"Direct send: batch CSV or a single contact from one chooser","href":"/guides/direct-send-chooser"},{"title":"Batch Send drafts \u0026 history: resume, delete, and review sent batches","href":"/guides/messages-batch-drafts-and-history"},{"title":"SMS task recipes: batch, webhook, or dashboard","href":"/guides/sms-task-recipes"},{"title":"SMS sending services: bundle numbers, opt-out list, and inbound webhook","href":"/guides/sms-services"},{"title":"Messaging services console: run the whole lifecycle from the dashboard","href":"/guides/messaging-services-console"},{"title":"Connect via SMPP: bind an SMPP client to Orbit","href":"/guides/smpp"},{"title":"SMPP production lifecycle: dlrMode, keepalive, reconnect, and DLR reconciliation","href":"/guides/smpp-production-lifecycle"},{"title":"SMPP wire-level recipes: hex walkthroughs of the bind and submit sequence","href":"/guides/smpp-recipes"},{"title":"SMPP: per-tenant no-delivery receipt window (receipt_timeout_seconds)","href":"/guides/smpp-receipt-timeout-window"},{"title":"Let SMPP bind traffic open Inbox conversations: the bind → Inbox opt-in","href":"/guides/smpp-inbox-binding-opt-in"},{"title":"Enable and Operate the SMS Double Opt-In Flow","href":"/guides/sms-double-opt-in-enforcement"},{"title":"Configure your LCR policy (Devotel-first vs BYO-first)","href":"/guides/configure-lcr-policy"}]},{"group":"Audience \u0026 Support Tools","pages":[{"title":"Users: personal presence, federation precedence, DND schedules, and status messages","href":"/users"},{"title":"Audience hub: the operator surface set for the customer data platform","href":"/audience/overview"},{"title":"Contacts hub: the per-person surface of the customer data platform","href":"/contacts/overview"},{"title":"Churn-risk console: rank your at-risk contacts and save a retention segment","href":"/guides/audience-churn-risk-console"},{"title":"Import and reconcile contacts: CSV jobs, merge, rollback","href":"/guides/import-contacts"},{"title":"First contact import: the end-to-end tutorial","href":"/guides/import-contacts-end-to-end"},{"title":"Import, dedupe, and upsert contacts as the source of truth","href":"/guides/import-and-upsert-contacts-at-scale"},{"title":"Import History console: status, skipped-row recovery, and resume for CSV contact imports","href":"/guides/audience-import-history-console"},{"title":"Run your senders from the Audience → Senders hub","href":"/guides/audience-senders-hub"},{"title":"First CDP activation, end to end: ingest → resolve → segment → ship","tag":"audiences","href":"/guides/cdp-first-activation-end-to-end"},{"title":"The CDP data flow: sources → identity → governance → activation → measurement","tag":"audiences","href":"/guides/cdp-pipeline-explainer"},{"title":"Batch-load CDP data from CSV, JSON, or JSONL files","tag":"audiences","href":"/guides/cdp-file-ingest"},{"title":"Consent-aware CDP ingest: bring a consented contact base in with lawful basis attached","href":"/guides/consent-aware-cdp-ingest"},{"title":"CDP audiences: build segments, computed traits, and activate","href":"/guides/cdp-segments"},{"title":"CDP Attribute Explorer: check segment feasibility before you write a rule","href":"/guides/cdp-attribute-explorer-segment-feasibility"},{"title":"CDP to CRM object sync: push segments into your CRM as native objects","href":"/guides/cdp-crm-object-sync"},{"title":"Activate segments into Braze, Iterable, and Customer.io","href":"/guides/cdp-martech-destinations-braze-iterable-customerio"},{"title":"Activate Klaviyo as a CDP destination","href":"/guides/cdp-klaviyo-destination-walkthrough"},{"title":"CDP to ERP object sync: push segments into NetSuite, SAP, Workday, or QuickBooks as native objects","href":"/guides/cdp-erp-object-sync"},{"title":"Static contact lists: create, fill, template, and export","href":"/guides/contact-lists-static-targeting"},{"title":"Computed traits: author deterministic trait rules","href":"/guides/computed-traits"},{"title":"SQL traits: author traits in warehouse SQL","href":"/guides/cdp-sql-traits"},{"title":"CDP tracking plan: declare event schemas and triage violations","href":"/guides/cdp-tracking-plan"},{"title":"CDP event schemas console: enforce a JSON Schema per event type with off, warn, and strict modes","href":"/guides/cdp-schemas-console"},{"title":"Sign CDP ingest requests without a client SDK","href":"/guides/cdp-ingest-signing"},{"title":"CDP integration console overview: every tab, catalog, and endpoint on Integrations → CDP","href":"/guides/cdp-integration-console-overview"},{"title":"CDP integration console: mint the ingest secret and wire outbound destinations","href":"/guides/cdp-source-and-destinations"},{"title":"CDP destinations: subscribe outbound receivers and hold the circuit breaker","href":"/guides/cdp-destinations"},{"title":"UID2 activation: mint, rotate, and export universal identifiers","href":"/guides/cdp-uid2-activation"},{"title":"CDP conversion forwarding: Meta CAPI, TikTok Events, and the multi-platform hub","href":"/guides/cdp-meta-tiktok-conversion-forwarding"},{"title":"CDP connector catalogs: sources, destinations, enrichment, BI, CRM/ERP, offers, and the clean room","href":"/guides/cdp-connectors-catalogs"},{"title":"CDP data catalog and identity rules: govern schemas and merging","href":"/guides/cdp-data-catalog-and-identity-rules"},{"title":"Identity-rule simulation: estimate the blast radius before you save","href":"/guides/cdp-identity-simulation"},{"title":"CDP reverse ETL to Snowflake and BigQuery","href":"/guides/reverse-etl-warehouse-exports"},{"title":"Reverse-ETL source query refusals: the single-SELECT rule and catalog kinds","href":"/troubleshooting/reverse-etl-source-sql-guards"},{"title":"CDP reverse ETL and data share: the operator walkthrough","href":"/guides/cdp-reverse-etl-and-warehouse-exports"},{"title":"CDP BI-tool connector catalog: pull Orbit data into Tableau, Power BI, Looker, Superset, or Metabase","href":"/guides/cdp-bi-connectors"},{"title":"CDP sync run log: drill into failed CRM sync rows","href":"/guides/cdp-sync-run-log"},{"title":"Event field mappings: reshape CDP events for each destination","href":"/guides/integrations-event-field-mappings"},{"title":"Warehouse-native segments (zero-copy audiences)","href":"/guides/warehouse-native-segments"},{"title":"Personalize website content: slots, segments, and the web SDK","href":"/guides/website-personalization-slots"},{"title":"Settings → Personalization: per-segment content for the web SDK","href":"/guides/settings-web-personalization"},{"title":"Contact \u0026 segment deliverability health","href":"/guides/contact-deliverability-health"},{"title":"Segment-triggered journeys: enroll segments into multi-step flows","href":"/guides/segment-triggered-journeys"},{"title":"Linked Audiences: build relational audiences over your warehouse entities","href":"/guides/linked-audiences"},{"title":"Use the Customer-360 workspace (and fetch the snapshot)","href":"/guides/customer-360-workspace"},{"title":"CDP predictive models: catalog, train, tier, and activate","href":"/guides/cdp-predictive-models"},{"title":"CDP erasure propagation: fan a DSAR deletion into every downstream store","href":"/guides/cdp-erasure-propagation"},{"title":"CDP PII tokenization and vault: govern sensitive identifiers","href":"/guides/cdp-pii-tokenization-and-vault"},{"title":"Next-best-product recommendations: test and rank per profile","href":"/guides/audience-recommendations-tester"},{"title":"Churn-risk scoring: read, segment, and act on per-contact risk","href":"/guides/churn-risk-scoring"},{"title":"Propensity segments: rank by predicted score and save as an audience","href":"/guides/propensity-segments"},{"title":"Account scores: B2B rollups of contact-level signals","href":"/guides/account-scores"},{"title":"Account relations: B2B account graphs and contact↔account links","href":"/guides/audience-accounts-relations"},{"title":"Identity resolution and merge: end-to-end walkthrough","href":"/guides/identity-resolution-and-merge-walkthrough"},{"title":"AI decisioning: next-best-action per profile","href":"/guides/ai-decisioning"},{"title":"Audience activation to ad networks: the operator walkthrough","tag":"audiences","href":"/guides/audience-activation-ad-network-walkthrough"},{"title":"Publish a segment to an external destination on a schedule","tag":"audiences","href":"/guides/audience-activation-pipeline"},{"title":"Export a one-off audience to CSV without saving a segment","tag":"audiences","href":"/guides/audience-export-adhoc"},{"title":"Consent inspector: per-contact consent records and destination verdicts","href":"/guides/audience-consent-inspector"},{"title":"Opt-outs console: read and act on the per-contact opt-out list","href":"/guides/audience-opt-outs-console"},{"title":"Identity resolution: resolve and merge duplicate contacts","href":"/guides/identity-resolution"},{"title":"Stitch anonymous sessions into known contacts","href":"/guides/anonymous-identity-stitching"},{"title":"Merge duplicate contacts end-to-end","href":"/guides/contact-merge"},{"title":"Merge workspace console: scan, pick fields, and fold duplicate contacts","href":"/guides/audience-merge-console"},{"title":"Custom fields: model contact metadata across segments, flows, and personalization","href":"/guides/custom-fields"},{"title":"Field schema explorer console walkthrough","href":"/guides/audience-fields-schema-explorer"},{"title":"Session replay: watch visitor sessions before a chat","href":"/guides/session-replay"},{"title":"High-friction sessions: read frustration signals and triage ranked replays","href":"/guides/high-friction-sessions-reading"},{"title":"Co-browse: live screen assistance from the chat widget","href":"/guides/cobrowse-live-assist"},{"title":"Observe-only co-browse in 15 minutes","href":"/guides/cobrowse-observe-only-setup"},{"title":"Web support end to end: widget, inbox, co-browse, replay","href":"/guides/support-widget-to-resolution"},{"title":"Support history (Support → Timeline)","href":"/guides/support-timeline"},{"title":"Search the archived conversation timeline for sales/support handover","href":"/guides/support-timeline-archived-search"},{"title":"Support timeline vs archived search: which surface answers your question","href":"/guides/support-timeline-surface"},{"title":"Support timeline end-to-end operator guide","href":"/guides/support-timeline-operator-guide"},{"title":"Team chat: operator workflows for channels, threads, and huddles","href":"/guides/team-chat"},{"title":"Team Chat first-run: your first channel, DMs, and notifications","href":"/guides/team-chat-first-channel-setup"},{"title":"Using Orby, the in-dashboard operator assistant","href":"/guides/orby-in-dashboard"},{"title":"Orby campaign diagnostics","href":"/guides/orby-campaign-diagnostics"},{"title":"Orby operator assistant: natural-language settings lookup","href":"/guides/orby-operator-assistant"},{"title":"Omnichannel Inbox setup: channels, routing, macros, SLA, AI drafts","href":"/guides/inbox-setup"},{"title":"Inbox Settings console: workspace defaults and per-agent overrides","href":"/guides/inbox-settings-console"},{"title":"Inbox saved views and share links","href":"/guides/inbox-saved-views-share-links"},{"title":"Inbox AI co-pilot: drafting pipeline, kill switch, confidence bar, and edge cases","href":"/guides/inbox-ai-copilot"},{"title":"Supervisor assist copilot for text and chat threads","href":"/guides/inbox-supervisor-assist-copilot"},{"title":"Pending replies — the supervisor approval queue for the Inbox","href":"/guides/inbox-pending-replies"},{"title":"Gate AI replies through reply-approvals and AI deflection","href":"/guides/inbox-reply-approvals"},{"title":"Send later — schedule an Inbox reply end to end","href":"/guides/inbox-send-later-scheduled-replies"},{"title":"Resend a failed outbound message from the Inbox thread","href":"/guides/inbox-thread-resend"},{"title":"Side conversations: loop in external vendors without exposing the customer thread","href":"/guides/inbox-side-conversations"},{"title":"Inbox terminology FAQ — replies, consent, and AI drafts","href":"/guides/inbox-terminology-faq"},{"title":"Unified inbox SLA engine: first-response and resolution timers with breach alerts","href":"/guides/inbox-sla-timers"},{"title":"Read the inbox SLA report and act on breaches","href":"/guides/inbox-sla-report-reading"},{"title":"Read first-reply-time metrics: what the number includes, and how to move it","href":"/guides/first-reply-time-reading"},{"title":"Inbox lifecycle hygiene — auto-close, and tags and dispositions at close","href":"/guides/inbox-history-hygiene"},{"title":"Work the Inbox Social Mentions queue","href":"/guides/inbox-social-mentions"},{"title":"Inbox tickets workflow","href":"/guides/inbox-tickets-workflow"},{"title":"Take a customer issue from open to resolution across the Inbox tickets surface","href":"/guides/inbox-ticket-resolution-lifecycle"},{"title":"Ticket-automation rules — author, dry-run, and roll out","href":"/guides/inbox-ticket-automation"},{"title":"Keep one-time codes out of the Inbox: transactional no-inbox mode","href":"/guides/transactional-inbox-no-conversation"},{"title":"Digital agent scripts: branching step graphs for live chat and messaging conversations","href":"/guides/inbox-agent-scripts"},{"title":"Team performance analytics for the digital inbox: supervisor KPIs, per-agent breakdown, weekly review","href":"/guides/inbox-team-performance"},{"title":"Inbox coaching: a supervisor playbook for digital conversations","href":"/guides/inbox-coaching"},{"title":"Teams: create, staff, and route conversations to them","href":"/guides/teams"},{"title":"Brand and Launch Your Hosted Help Center","href":"/guides/help-center-portal"},{"title":"Run a Public Community Q\u0026A Forum","href":"/guides/community-qa-forum"},{"title":"Run a Public Idea Board and Roadmap","href":"/guides/ideas-feature-request-portal"},{"title":"Macros and canned responses — the inbox reply library","href":"/guides/macros-canned-responses"},{"title":"Design inbox dispositions — label sets, AI judge assignment, outcome distribution","href":"/guides/inbox-dispositions"},{"title":"Inbox hub","href":"/inbox/overview"},{"title":"Inbox settings map — every operator console in one place","href":"/inbox/settings-map"},{"title":"AI deflection budget — cap, soft alert, and savings","href":"/inbox/ai-deflection-budget"},{"title":"Inbox dispositions — outcome labels on closed conversations","href":"/inbox/dispositions"},{"title":"Routing rules — auto-assign inbound conversations","href":"/inbox/routing-rules"},{"title":"Digital queues — skill-based ACD for the inbox","href":"/inbox/digital-queues"},{"title":"Inbox tags — the vocabulary routing, filters, and reporting run on","href":"/inbox/tags"},{"title":"The QM coaching loop: queue, notes, scorecards, effectiveness","href":"/inbox/coaching"},{"title":"Agent scripts: guided branching reply flows for digital conversations","href":"/inbox/agent-scripts"},{"title":"Conversation operators: the classifier signal pipeline","href":"/inbox/conversation-operators"},{"title":"Run the conversation-intelligence operator console","href":"/guides/conversation-operators-console"},{"title":"Auto-close stale conversations","href":"/inbox/auto-close"},{"title":"Per-digital-queue inbox SLA escalation policies","href":"/inbox/sla-escalation-policies"},{"title":"Ticket automation — event-driven ticket rules","href":"/inbox/ticket-automation"},{"title":"Social listening and public-mention triage","href":"/inbox/social-mentions"},{"title":"Reply approvals — the supervisor review gate for the inbox","href":"/inbox/reply-approvals"},{"title":"Pending replies queue — the supervisor workflow from login to decision","href":"/inbox/pending-replies"},{"title":"QA workload management: assign evaluations, quotas and due dates","href":"/guides/qa-workload-management"},{"title":"Quality hub: a supervisor's map of the dashboard","href":"/quality/overview"},{"title":"The Quality hub: leaderboard, scorecards, and evaluations from one page","href":"/guides/quality-hub-overview"},{"title":"Agent first-week onboarding journey","href":"/guides/agent-first-week-onboarding-journey"},{"title":"Run your first QA evaluation, from rubric to coaching plan","href":"/guides/first-qa-evaluation-end-to-end"},{"title":"Build a contact-center QA program","href":"/guides/quality-management-program"},{"title":"Play, search, and grade recordings from the Recording Library","href":"/guides/quality-recordings"},{"title":"Quality leaderboard: scoring rules, badges, and thresholds","href":"/guides/quality-leaderboard"},{"title":"Per-agent coaching cards and the compliance-flag queue on Quality","href":"/guides/quality-coaching-cards"},{"title":"QA scorecard trends: read the org-wide score series and act on drift","href":"/guides/quality-trends-supervisor"},{"title":"The Quality hub: run the supervisor loop across evaluations, recordings, leaderboard, and practice","href":"/guides/quality-hub-supervisor-loop"},{"title":"AI Auto-QA: enable toggle, flag threshold, and where auto-scores land","href":"/guides/qa-autoscore-settings"},{"title":"AI auto-QA readiness: read the dashboard card that pre-flights the whole pipeline","href":"/guides/qa-autoscore-readiness-panel"},{"title":"Batch-ingest agent desktop screen recordings","href":"/guides/desktop-screen-recording-ingest"},{"title":"Read your own QM scorecard","href":"/guides/my-scorecard"},{"title":"My scorecard reference","href":"/me/scorecard"},{"title":"My profile: your scorecard and voice preferences","href":"/guides/me-profile-and-voice"},{"title":"Agent scorecard: one page per agent under Quality → Agents","href":"/guides/agent-scorecard"},{"title":"Supervisor guide: the agent scorecard drill-down","href":"/guides/supervisor-agent-scorecard-drilldown"},{"title":"Train agents with AI roleplay in Practice Studio","href":"/guides/practice-studio-roleplay"},{"title":"Workforce-management workflows","href":"/guides/wfm-workflows"},{"title":"Publish your first weekly roster","href":"/guides/voice-scheduling-first-roster"},{"title":"Workforce forecasts and staffing optimization","href":"/guides/wfm-forecasts-and-staffing-optimizer"},{"title":"Contact center staffing math: Erlang C, shrinkage, and seasonal headcount","href":"/guides/contact-center-staffing-math"},{"title":"Intraday adherence and agent requests","href":"/guides/wfm-intraday-adherence-and-requests"},{"title":"Agent wellness and flight risk","href":"/guides/wfm-agent-wellness-and-flight-risk"},{"title":"Wallboard: supervisor real-time tiles for TV-mounted displays","href":"/guides/wallboard"},{"title":"Runbook: wallboard on TV — set up, rotate, and retire a shared display","href":"/guides/wallboard-tv-setup"},{"title":"Voice wallboard console: TV mode and SLA telemetry","href":"/guides/wallboard-console"},{"title":"Contact Center live operations floor: a first-week supervisor walkthrough","href":"/guides/contact-center-live-floor"},{"title":"Supervisor live monitoring for voice calls: listen, whisper, barge","href":"/guides/supervisor-live-monitoring-voice"},{"title":"Supervisor warm takeover and coach mode for live voice calls","href":"/guides/supervisor-takeover-warm-handoff"},{"title":"Supervisor live speech analytics stream","href":"/guides/supervisor-live-speech-analytics-stream"},{"title":"Supervisor live monitoring for digital conversations: watch, whisper, barge","href":"/guides/supervisor-live-monitoring-digital"},{"title":"Real-time agent-assist whisper coaching in the softphone","href":"/guides/agent-assist-whisper-coaching"},{"title":"Supervisor coaching: plans, templates, and effectiveness reporting","href":"/guides/supervisor-coaching"},{"title":"Voice coaching plans: author, track, and close with measured impact","href":"/guides/voice-coaching-plans"},{"title":"Coaching templates: curate the supervisor snippet library","href":"/guides/voice-coaching-templates"},{"title":"Supervisor agent detail: state history and performance","href":"/guides/voice-agents-supervisor-view"}]}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Orbit REST API overview: auth, pagination, and errors","href":"/api-reference/overview"},{"title":"API versioning \u0026 deprecation","href":"/api-reference/versioning"},{"group":"Messaging","pages":[{"title":"Messages API","icon":"comment-dots","href":"/api-reference/endpoints/messaging"},{"title":"Message Status Lifecycle","href":"/api-reference/messages-status-lifecycle"},{"title":"Risk API","icon":"hashtag","href":"/api-reference/endpoints/risk"},{"title":"Risk API: unified cross-channel Trust \u0026 Fraud score","href":"/api-reference/risk"},{"title":"WhatsApp API","icon":"hashtag","href":"/api-reference/endpoints/whatsapp"},{"title":"WhatsApp API: WABA, profile, catalogs, and Flows","href":"/api-reference/whatsapp"},{"title":"RCS API","icon":"hashtag","href":"/api-reference/endpoints/rcs"},{"title":"RCS API: brand registration, agents, templates, testers","href":"/api-reference/rcs"},{"title":"Telegram API","icon":"hashtag","href":"/api-reference/endpoints/telegram"},{"title":"Telegram API: connect a bot and read channel state","href":"/api-reference/telegram"},{"title":"USSD API","icon":"hashtag","href":"/api-reference/endpoints/ussd"},{"title":"USSD API: menu trees, sessions, and aggregator callbacks","href":"/api-reference/ussd"},{"title":"Fax API","icon":"fax","href":"/api-reference/endpoints/fax"},{"title":"Fax API: send and receive faxes with status webhooks","href":"/api-reference/fax"},{"title":"Email API","icon":"hashtag","href":"/api-reference/endpoints/email"},{"title":"Email API: list-unsubscribe and address validation","href":"/api-reference/email"},{"title":"Push API","icon":"bell","href":"/api-reference/endpoints/push"},{"title":"Push Notifications API: register FCM and APNs devices","href":"/api-reference/push"},{"title":"Conversation thread endpoints for SMS, WhatsApp, email","icon":"comments","href":"/api-reference/endpoints/conversations"},{"title":"Conversations API: reply, assign, and hand off threads","href":"/api-reference/conversations"},{"title":"Inbox endpoints: agent assignment, snooze, and notes","icon":"inbox","href":"/api-reference/endpoints/inbox"},{"title":"Inbox API: presence, saved views, routing, notes, macros","href":"/api-reference/inbox"},{"title":"SessionReplay API","icon":"hashtag","href":"/api-reference/endpoints/sessionreplay"},{"title":"Session Replay API: fetch and purge web session recordings","href":"/api-reference/session-replay"},{"title":"Cobrowse API","icon":"hashtag","href":"/api-reference/endpoints/cobrowse"},{"title":"Co-browse API: join and end live browser sessions","href":"/api-reference/cobrowse"},{"title":"Web widget: embed and anonymous visitor API","href":"/api-reference/web-widget"},{"title":"BYO-SMPP Credentials API: send SMS over your own carrier","href":"/api-reference/messaging-credentials"},{"title":"Messaging Services API","icon":"hashtag","href":"/api-reference/endpoints/messaging-services"},{"title":"Templates API","icon":"hashtag","href":"/api-reference/endpoints/templates"},{"title":"Templates API: cross-channel approved message templates","href":"/api-reference/templates"},{"title":"Channels API","icon":"hashtag","href":"/api-reference/endpoints/channels"}]},{"group":"Voice \u0026 Numbers","pages":[{"title":"Voice API","icon":"phone","href":"/api-reference/endpoints/voice"},{"title":"Voice API: calls, SIP trunks, IVR, and conferences","href":"/api-reference/voice"},{"title":"Jambonz API","icon":"hashtag","href":"/api-reference/endpoints/jambonz"},{"title":"Orbit Voice Protocol","tag":"Design preview","href":"/api-reference/orbit-voice"},{"title":"Recordings API","icon":"hashtag","href":"/api-reference/endpoints/recordings"},{"title":"Recordings API: legal holds, integrity seals, and shares","href":"/api-reference/recordings"},{"title":"Dialer API","icon":"hashtag","href":"/api-reference/endpoints/dialer"},{"title":"Dialer API: preview, progressive, and predictive campaigns","href":"/api-reference/dialer"},{"title":"Numbers API","icon":"hashtag","href":"/api-reference/endpoints/numbers"},{"title":"Numbers API overview: buy and route phone numbers","href":"/api-reference/numbers"},{"title":"Network APIs: GSMA Open Gateway and CAMARA endpoints","href":"/api-reference/network-apis"},{"title":"Network APIs API","icon":"tower-cell","href":"/api-reference/endpoints/network-apis"},{"title":"Verify API","icon":"shield-halved","href":"/api-reference/endpoints/verify"},{"title":"Verify API: send and check OTP codes across channels","href":"/api-reference/verify"},{"title":"Get verification detail: channels, fallback, code log","href":"/api-reference/verify-detail"},{"title":"Verify Passkey API","icon":"hashtag","href":"/api-reference/endpoints/verify-passkey"},{"title":"Verify Push API","icon":"hashtag","href":"/api-reference/endpoints/verify-push"},{"title":"SIP credentials API: register softphones and desk phones against Orbit","href":"/api-reference/sip-credentials"},{"title":"Proxy API","icon":"shuffle","href":"/api-reference/endpoints/proxy"},{"title":"Number Masking (Proxy) API","href":"/api-reference/proxy"},{"title":"Voice Biometrics API","icon":"fingerprint","href":"/api-reference/endpoints/voice-biometrics"},{"title":"Verify Push API","icon":"hashtag","href":"/api-reference/endpoints/verify-push"},{"title":"Verify Passkey API","icon":"hashtag","href":"/api-reference/endpoints/verify-passkey"},{"title":"WhatsApp Calling API","icon":"phone-volume","href":"/api-reference/endpoints/whatsapp-calling"}]},{"group":"AI \u0026 Agents","pages":[{"title":"MCP API","icon":"hashtag","href":"/api-reference/endpoints/mcp"},{"title":"Agents API","icon":"robot","href":"/api-reference/endpoints/agents"},{"title":"Agents API overview: AI agents on messaging and voice","href":"/api-reference/agents"},{"title":"AI assistants: create, deploy, and run the lifecycle","href":"/api-reference/assistants"},{"title":"Assistant templates: instantiate, preview, and test","href":"/api-reference/assistant-templates"},{"title":"AI API","icon":"hashtag","href":"/api-reference/endpoints/ai"},{"title":"AI API: translation, classification, and generation","href":"/api-reference/ai"},{"title":"Organizations API","icon":"hashtag","href":"/api-reference/endpoints/organizations"},{"title":"Orby API","icon":"hashtag","href":"/api-reference/endpoints/orby"},{"title":"Orby Assistant API: drive the in-dashboard operator AI","href":"/api-reference/orby"},{"title":"Knowledge Bases API","icon":"hashtag","href":"/api-reference/endpoints/knowledge-bases"},{"title":"Knowledge Bases API: vector search for AI agent RAG","href":"/api-reference/knowledge-bases"},{"title":"KnowledgeBases API","icon":"hashtag","href":"/api-reference/endpoints/knowledgebases"},{"title":"Agent Marketplace API: browse, install, and submit agents","href":"/api-reference/marketplace"},{"title":"Insights API: AI agent cost, ROI, and containment","href":"/api-reference/insights"},{"title":"Insights API","icon":"hashtag","href":"/api-reference/endpoints/insights"},{"title":"Configure and read Agent ROI attribution","href":"/guides/agent-roi-attribution"},{"title":"Agent custom outcome metrics: author rubrics, stamp outcomes, read ROI","href":"/guides/agent-custom-outcome-metrics"},{"title":"Read the AI Containment and Resolution dashboard","href":"/guides/agent-containment-dashboard"},{"title":"WFM API","icon":"hashtag","href":"/api-reference/endpoints/wfm"},{"title":"Workforce Management API: forecast, schedule, adherence","href":"/api-reference/wfm"},{"title":"Quality API","icon":"hashtag","href":"/api-reference/endpoints/quality"},{"title":"Quality Management API: scorecards and agent calibration","href":"/api-reference/quality"},{"title":"Practice Studio API","icon":"hashtag","href":"/api-reference/endpoints/practice-studio"}]},{"group":"Automation","pages":[{"title":"Flows API","icon":"hashtag","href":"/api-reference/endpoints/flows"},{"title":"Campaigns API","icon":"bullhorn","href":"/api-reference/endpoints/campaigns"},{"title":"Surveys API","icon":"clipboard-list","href":"/api-reference/endpoints/surveys"},{"title":"Webhooks API","icon":"bell-concierge","href":"/api-reference/endpoints/webhooks"},{"title":"Events API","icon":"hashtag","href":"/api-reference/endpoints/events"},{"title":"Events API: platform event firehose over REST and SSE","href":"/api-reference/events"},{"title":"Event Sinks API: stream Orbit events to Kafka or HTTP","href":"/api-reference/event-sinks"},{"title":"Oncall API","icon":"hashtag","href":"/api-reference/endpoints/oncall"},{"title":"On-Call API: rotations and escalation policies","href":"/api-reference/oncall"}]},{"group":"Audience","pages":[{"title":"Contacts API","icon":"users","href":"/api-reference/endpoints/contacts"},{"title":"Contact Lists API: static audiences you curate by hand","href":"/api-reference/contact-lists"},{"title":"CDP API for unified profiles, events, and audience sync","icon":"hashtag","href":"/api-reference/endpoints/cdp"},{"title":"Ads API","icon":"hashtag","href":"/api-reference/endpoints/ads"},{"title":"Meta Ads API: click-to-chat, CAPI, and Lead Ads","href":"/api-reference/ads"},{"title":"Opt-Outs API: per-contact channel consent and CSV sync","href":"/api-reference/optouts"},{"title":"CustomFields API","icon":"tag","href":"/api-reference/endpoints/custom-fields"},{"title":"Custom Fields API: typed contact metadata","href":"/api-reference/custom-fields"},{"title":"FrequencyCaps API","icon":"gauge","href":"/api-reference/endpoints/frequency-caps"},{"title":"Frequency Caps API: per-contact rolling send limits","href":"/api-reference/frequency-caps"},{"title":"MessageSuppression API","icon":"hashtag","href":"/api-reference/endpoints/messagesuppression"},{"title":"Message Suppression API: dedupe sends by content hash","href":"/api-reference/message-suppression"},{"title":"Opt-Out Lists API","icon":"hashtag","href":"/api-reference/endpoints/opt-out-lists"},{"title":"Sender Pools API","icon":"hashtag","href":"/api-reference/endpoints/sender-pools"},{"title":"SMPP API","icon":"hashtag","href":"/api-reference/endpoints/smpp"},{"title":"Personalization API: web SDK content slot definitions","href":"/api-reference/personalization"},{"title":"Links API","icon":"hashtag","href":"/api-reference/endpoints/links"},{"title":"Short Links API: branded links and click statistics","href":"/api-reference/links"},{"title":"Misc API","icon":"hashtag","href":"/api-reference/endpoints/misc"},{"title":"QR Code API: generate codes for URLs and deep links","href":"/api-reference/qr"},{"title":"Segments API","icon":"hashtag","href":"/api-reference/endpoints/segments"},{"title":"Segments API: build and export contact audiences","href":"/api-reference/segments"},{"title":"Loyalty API","icon":"hashtag","href":"/api-reference/endpoints/loyalty"},{"title":"Loyalty API: points, tiers, and redemption endpoints","href":"/api-reference/loyalty"},{"title":"Incentives API","icon":"hashtag","href":"/api-reference/endpoints/incentives"},{"title":"WalletPasses API","icon":"hashtag","href":"/api-reference/endpoints/walletpasses"}]},{"group":"Commerce","pages":[{"title":"Commerce API","icon":"hashtag","href":"/api-reference/endpoints/commerce"},{"title":"Commerce API: cart, checkout, and pay-by-link","href":"/api-reference/commerce"},{"title":"Agentic Commerce API","icon":"hashtag","href":"/api-reference/endpoints/agentic-commerce"},{"title":"WalletPasses API","icon":"hashtag","href":"/api-reference/endpoints/walletpasses"}]},{"group":"Sync","pages":[{"title":"Sync API","icon":"hashtag","href":"/api-reference/endpoints/sync"},{"title":"Sync API: real-time Documents, Maps, Lists, and Streams","href":"/api-reference/sync"}]},{"group":"Team Chat","pages":[{"title":"TeamChat API","icon":"hashtag","href":"/api-reference/endpoints/teamchat"},{"title":"Team Chat API: internal channels, threads, and huddles","href":"/api-reference/team-chat"}]},{"group":"Media \u0026 Content","pages":[{"title":"Email Builder API","icon":"envelope","href":"/api-reference/endpoints/email-builder"},{"title":"Files API","icon":"hashtag","href":"/api-reference/endpoints/files"},{"title":"Files API: upload, list, and delete media attachments","href":"/api-reference/files"},{"title":"Video API","icon":"hashtag","href":"/api-reference/endpoints/video"},{"title":"Video API: schedule, join, and record Orbit Media rooms","href":"/api-reference/video"},{"title":"Content API","icon":"hashtag","href":"/api-reference/endpoints/content"}]},{"group":"Account","pages":[{"title":"Account API","icon":"circle-user","href":"/api-reference/endpoints/account"},{"title":"Me API","icon":"hashtag","href":"/api-reference/endpoints/me"},{"title":"Onboarding API","icon":"hashtag","href":"/api-reference/endpoints/onboarding"},{"title":"Auth API","icon":"hashtag","href":"/api-reference/endpoints/auth"},{"title":"Billing API overview: prepaid wallet and invoices","href":"/api-reference/billing"},{"title":"Billing API","icon":"hashtag","href":"/api-reference/endpoints/billing"},{"title":"Pricing API","icon":"hashtag","href":"/api-reference/endpoints/pricing"},{"title":"Organization API: profile, KYC, and custom domains","href":"/api-reference/organization"},{"title":"Organization API","icon":"hashtag","href":"/api-reference/endpoints/organization"},{"title":"Health API","icon":"hashtag","href":"/api-reference/endpoints/health"},{"title":"Stats API","icon":"hashtag","href":"/api-reference/endpoints/stats"},{"title":"Sandbox API","icon":"hashtag","href":"/api-reference/endpoints/sandbox"},{"title":"Testing API","icon":"hashtag","href":"/api-reference/endpoints/testing"},{"title":"Notifications API","icon":"hashtag","href":"/api-reference/endpoints/notifications"},{"title":"Notifications API: in-app alerts and SSE stream","href":"/api-reference/notifications"},{"title":"Subaccounts API: manage child orgs and credit transfers","href":"/api-reference/subaccounts"},{"title":"Subaccounts API","icon":"hashtag","href":"/api-reference/endpoints/subaccounts"},{"title":"Sub-account settings API: recipes","href":"/guides/api-recipes/subaccounts-settings"},{"title":"Reseller Usage Metering API: rate, roll up, invoice","href":"/api-reference/usage-metering"},{"title":"Usage API","icon":"hashtag","href":"/api-reference/endpoints/usage"},{"title":"UsageRecords API","icon":"hashtag","href":"/api-reference/endpoints/usagerecords"},{"title":"CDR Export API: per-call and per-message billing reconciliation feed","href":"/api-reference/cdr-export"},{"title":"Effective branding: logo, colors, and brand per tenant","href":"/api-reference/branding"},{"title":"Branding API","icon":"hashtag","href":"/api-reference/endpoints/branding"},{"title":"Settings API","icon":"gear","href":"/api-reference/endpoints/settings"},{"title":"Settings API overview: org, users, keys, and SSO","href":"/api-reference/settings"},{"title":"Teams API","icon":"hashtag","href":"/api-reference/endpoints/teams"},{"title":"Analytics API","icon":"hashtag","href":"/api-reference/endpoints/analytics"},{"title":"Analytics API: message metrics and scheduled reports","href":"/api-reference/analytics"},{"title":"SMS click-through parity: per-campaign and per-queue CTR","href":"/api-reference/sms-click-through"},{"title":"Reports API","icon":"hashtag","href":"/api-reference/endpoints/reports"},{"title":"Search API","icon":"hashtag","href":"/api-reference/endpoints/search"},{"title":"Search Analytics API: top queries and zero-result rates","href":"/api-reference/search-analytics"},{"title":"Tail API","icon":"hashtag","href":"/api-reference/endpoints/tail"},{"title":"Live request-log tail","href":"/api-reference/log-tail"},{"title":"Developer API","icon":"hashtag","href":"/api-reference/endpoints/developer"},{"title":"Integrations API","icon":"hashtag","href":"/api-reference/endpoints/integrations"},{"title":"Integrations API: connect Salesforce, HubSpot, and more","href":"/api-reference/integrations"},{"title":"Imports API","icon":"hashtag","href":"/api-reference/endpoints/imports"},{"title":"Imports API: one-click migration from another provider","href":"/api-reference/imports"},{"title":"Run referral programs, issue codes, and pay rewards","href":"/api-reference/referrals"},{"title":"Referrals API","icon":"hashtag","href":"/api-reference/endpoints/referrals"},{"title":"Feedback API","icon":"comment","href":"/api-reference/endpoints/feedback"}]},{"group":"Compliance","pages":[{"title":"Compliance API: DSAR, consent, and opt-out records","icon":"scale-balanced","href":"/api-reference/endpoints/compliance"},{"title":"Brand Identity API","icon":"hashtag","href":"/api-reference/endpoints/brand-identity"},{"title":"Brand Identity API: cross-channel trust scoring","href":"/api-reference/brand-identity"}]},{"group":"Help Center","pages":[{"title":"Help Center API","icon":"circle-question","href":"/api-reference/endpoints/help-center"}]},{"group":"Status Page","pages":[{"title":"Status Page API","icon":"tower-broadcast","href":"/api-reference/endpoints/status-page"},{"title":"Health API","icon":"hashtag","href":"/api-reference/endpoints/health"}]},{"group":"Public API","pages":[{"title":"Public API","icon":"hashtag","href":"/api-reference/endpoints/public"}]},{"group":"Embedded SDK","pages":[{"title":"Embedded Web SDK API: identify visitors and track events","href":"/api-reference/sdk"}]},{"title":"Which languages each endpoint page ships","href":"/api-reference/sdk-language-policy"},{"title":"How request samples work (cURL + 5 SDK languages)","href":"/api-reference/sdk-sample-writing"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"group":"Sandbox","pages":[{"title":"Sandbox: orientation for test mode","href":"/sandbox/overview"},{"title":"Sandbox magic numbers: simulate delivery receipts by digit","href":"/sandbox/magic-numbers"},{"title":"Pre-launch checklist: walk the five gates to go-live","href":"/sandbox/pre-launch-checklist"}]}]},{"group":"All Endpoints","pages":[{"group":"Misc","pages":[{"title":"Follow a referral link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /r/{code}","href":"/api-reference/all-endpoints/misc/follow-a-referral-link"},{"title":"Follow a signed email link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /r/{sig}/{target}","href":"/api-reference/all-endpoints/misc/follow-a-signed-email-link"},{"title":"Fire a conversion-tracking pixel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /g/{goalId}/{contactId}.gif","href":"/api-reference/all-endpoints/misc/fire-a-conversion-tracking-pixel"},{"title":"Fire an email open-tracking pixel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /p/{sig}.gif","href":"/api-reference/all-endpoints/misc/fire-an-email-open-tracking-pixel"},{"title":"Follow a tracked short link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /l/{code}","href":"/api-reference/all-endpoints/misc/follow-a-tracked-short-link"},{"title":"Render a published landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lp/{code}","href":"/api-reference/all-endpoints/misc/render-a-published-landing-page"},{"title":"Record a landing page conversion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lp/{code}/convert","href":"/api-reference/all-endpoints/misc/record-a-landing-page-conversion"},{"title":"Initiate SAML SSO login","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/saml/{orgSlug}/login","href":"/api-reference/all-endpoints/misc/initiate-saml-sso-login"},{"title":"Complete SAML SSO login","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/saml/{orgSlug}/callback","href":"/api-reference/all-endpoints/misc/complete-saml-sso-login"},{"title":"Download the SAML SP metadata XML","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/saml/{orgSlug}/metadata","href":"/api-reference/all-endpoints/misc/download-the-saml-sp-metadata-xml"},{"title":"Initiate SAML single logout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auth/saml/{orgSlug}/logout","href":"/api-reference/all-endpoints/misc/initiate-saml-single-logout"},{"title":"List ServiceProviderConfig","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/ServiceProviderConfig","href":"/api-reference/all-endpoints/misc/list-serviceproviderconfig"},{"title":"List ResourceTypes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/ResourceTypes","href":"/api-reference/all-endpoints/misc/list-resourcetypes"},{"title":"List Schemas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Schemas","href":"/api-reference/all-endpoints/misc/list-schemas"},{"title":"List Users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Users","href":"/api-reference/all-endpoints/misc/list-users"},{"title":"Create Users","deprecated":null,"version":null,"openapi":"/openapi.yaml post /scim/v2/{orgSlug}/Users","href":"/api-reference/all-endpoints/misc/create-users"},{"title":"Get Users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Users/{id}","href":"/api-reference/all-endpoints/misc/get-users"},{"title":"Update Users","deprecated":null,"version":null,"openapi":"/openapi.yaml put /scim/v2/{orgSlug}/Users/{id}","href":"/api-reference/all-endpoints/misc/update-users"},{"title":"Delete Users","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /scim/v2/{orgSlug}/Users/{id}","href":"/api-reference/all-endpoints/misc/delete-users"},{"title":"Patch Users","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /scim/v2/{orgSlug}/Users/{id}","href":"/api-reference/all-endpoints/misc/patch-users"},{"title":"List provisioned groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Groups","href":"/api-reference/all-endpoints/misc/list-provisioned-groups"},{"title":"Get a provisioned group","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Groups/{id}","href":"/api-reference/all-endpoints/misc/get-a-provisioned-group"},{"title":"Patch Groups","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /scim/v2/{orgSlug}/Groups/{id}","href":"/api-reference/all-endpoints/misc/patch-groups"},{"title":"List provisioned agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Agents","href":"/api-reference/all-endpoints/misc/list-provisioned-agents"},{"title":"Get a provisioned agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scim/v2/{orgSlug}/Agents/{id}","href":"/api-reference/all-endpoints/misc/get-a-provisioned-agent"},{"title":"Deprovision an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /scim/v2/{orgSlug}/Agents/{id}","href":"/api-reference/all-endpoints/misc/deprovision-an-agent"},{"title":"Suspend or reinstate an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /scim/v2/{orgSlug}/Agents/{id}","href":"/api-reference/all-endpoints/misc/suspend-or-reinstate-an-agent"},{"title":"Identify sdk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sdk/identify","href":"/api-reference/all-endpoints/misc/identify-sdk"},{"title":"Track sdk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sdk/track","href":"/api-reference/all-endpoints/misc/track-sdk"},{"title":"Anonymous track","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sdk/track/anonymous","href":"/api-reference/all-endpoints/misc/anonymous-track"},{"title":"List personalize","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sdk/personalize","href":"/api-reference/all-endpoints/misc/list-personalize"},{"title":"List feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sdk/in-app/feed","href":"/api-reference/all-endpoints/misc/list-feed"},{"title":"Events in-app","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sdk/in-app/events","href":"/api-reference/all-endpoints/misc/events-in-app"},{"title":"Ingest a CDP track event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/track","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-track-event"},{"title":"Ingest a CDP identify call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/identify","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-identify-call"},{"title":"Ingest a CDP page view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/page","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-page-view"},{"title":"Ingest a CDP screen view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/screen","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-screen-view"},{"title":"Ingest a CDP group association","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/group","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-group-association"},{"title":"Ingest a CDP identity alias","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/alias","href":"/api-reference/all-endpoints/misc/ingest-a-cdp-identity-alias"},{"title":"Ingest a batch of CDP events","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/batch","href":"/api-reference/all-endpoints/misc/ingest-a-batch-of-cdp-events"}]},{"group":"Public","pages":[{"title":"Submit a marketing lead","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/marketing-leads","href":"/api-reference/all-endpoints/public/submit-a-marketing-lead"},{"title":"List questions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/community/questions","href":"/api-reference/all-endpoints/public/list-questions"},{"title":"Questions community","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/community/questions","href":"/api-reference/all-endpoints/public/questions-community"},{"title":"Get questions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/community/questions/{id}","href":"/api-reference/all-endpoints/public/get-questions"},{"title":"Create answers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/community/questions/{id}/answers","href":"/api-reference/all-endpoints/public/create-answers"},{"title":"Create vote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/community/questions/{id}/vote","href":"/api-reference/all-endpoints/public/create-vote"},{"title":"Create vote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/community/answers/{id}/vote","href":"/api-reference/all-endpoints/public/create-vote-1"},{"title":"List ideas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/ideas","href":"/api-reference/all-endpoints/public/list-ideas"},{"title":"Ideas public","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/ideas","href":"/api-reference/all-endpoints/public/ideas-public"},{"title":"List roadmap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/ideas/roadmap","href":"/api-reference/all-endpoints/public/list-roadmap"},{"title":"Get ideas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/ideas/{id}","href":"/api-reference/all-endpoints/public/get-ideas"},{"title":"Create vote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/ideas/{id}/vote","href":"/api-reference/all-endpoints/public/create-vote-2"},{"title":"Create comments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/ideas/{id}/comments","href":"/api-reference/all-endpoints/public/create-comments"},{"title":"List pages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/pages","href":"/api-reference/all-endpoints/public/list-pages"},{"title":"Get pages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/pages/{slug}","href":"/api-reference/all-endpoints/public/get-pages"},{"title":"List stale","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/stale","href":"/api-reference/all-endpoints/public/list-stale"},{"title":"List transcript","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/conversations/{token}/transcript","href":"/api-reference/all-endpoints/public/list-transcript"},{"title":"Get recordings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/recordings/{token}","href":"/api-reference/all-endpoints/public/get-recordings"},{"title":"Get videos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/videos/{token}","href":"/api-reference/all-endpoints/public/get-videos"},{"title":"List raw","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/videos/{token}/raw","href":"/api-reference/all-endpoints/public/list-raw"},{"title":"Get callbacks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/callbacks/{token}","href":"/api-reference/all-endpoints/public/get-callbacks"},{"title":"List status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/callbacks/{token}/status","href":"/api-reference/all-endpoints/public/list-status"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/callbacks/{token}/cancel","href":"/api-reference/all-endpoints/public/create-cancel"},{"title":"Create reschedule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/callbacks/{token}/reschedule","href":"/api-reference/all-endpoints/public/create-reschedule"},{"title":"List embed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/analytics/dashboards/embed","href":"/api-reference/all-endpoints/public/list-embed"},{"title":"Subprocessor-subscriptions public","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/subprocessor-subscriptions","href":"/api-reference/all-endpoints/public/subprocessor-subscriptions-public"},{"title":"List confirm","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/subprocessor-subscriptions/confirm","href":"/api-reference/all-endpoints/public/list-confirm"},{"title":"List unsubscribe","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/subprocessor-subscriptions/unsubscribe","href":"/api-reference/all-endpoints/public/list-unsubscribe"}]},{"group":"Compliance","pages":[{"title":"Meta data-deletion callback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/meta/data-deletion","href":"/api-reference/all-endpoints/compliance/meta-data-deletion-callback"},{"title":"Check a data-deletion status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/meta/data-deletion/status/{code}","href":"/api-reference/all-endpoints/compliance/check-a-data-deletion-status"},{"title":"Start a public DSAR identity-proof claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/begin","href":"/api-reference/all-endpoints/compliance/start-a-public-dsar-identity-proof-claim"},{"title":"Verify the DSAR email verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/verify-email","href":"/api-reference/all-endpoints/compliance/verify-the-dsar-email-verification-code"},{"title":"Resend the DSAR email verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/resend-email","href":"/api-reference/all-endpoints/compliance/resend-the-dsar-email-verification-code"},{"title":"Send the DSAR phone verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/send-phone","href":"/api-reference/all-endpoints/compliance/send-the-dsar-phone-verification-code"},{"title":"Verify the DSAR phone verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/verify-phone","href":"/api-reference/all-endpoints/compliance/verify-the-dsar-phone-verification-code"},{"title":"Submit the verified DSAR claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/public/dsar/submit","href":"/api-reference/all-endpoints/compliance/submit-the-verified-dsar-claim"},{"title":"Capture a public consent opt-in or opt-out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/consent","href":"/api-reference/all-endpoints/compliance/capture-a-public-consent-opt-in-or-opt-out"},{"title":"Get a tenant's public consent-form config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/consent/{tenantId}/config","href":"/api-reference/all-endpoints/compliance/get-a-tenants-public-consent-form-config"},{"title":"Force a compliance country-coverage sync","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/admin/sync","href":"/api-reference/all-endpoints/compliance/force-a-compliance-country-coverage-sync"},{"title":"List country sender ID compliance rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/countries","href":"/api-reference/all-endpoints/compliance/list-country-sender-id-compliance-rules"},{"title":"Get one country's sender ID rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/countries/{code}","href":"/api-reference/all-endpoints/compliance/get-one-countrys-sender-id-rules"},{"title":"Check sender ID compliance for a country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/check","href":"/api-reference/all-endpoints/compliance/check-sender-id-compliance-for-a-country"},{"title":"List 10DLC brands","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/brands","href":"/api-reference/all-endpoints/compliance/list-10dlc-brands"},{"title":"Register a new 10DLC brand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/brands","href":"/api-reference/all-endpoints/compliance/register-a-new-10dlc-brand"},{"title":"List 10DLC campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/campaigns","href":"/api-reference/all-endpoints/compliance/list-10dlc-campaigns"},{"title":"Register a 10DLC campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/campaigns","href":"/api-reference/all-endpoints/compliance/register-a-10dlc-campaign"},{"title":"Assign phone numbers to a 10DLC campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/campaigns/{id}/numbers","href":"/api-reference/all-endpoints/compliance/assign-phone-numbers-to-a-10dlc-campaign"},{"title":"Register a 10DLC brand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/brand","href":"/api-reference/all-endpoints/compliance/register-a-10dlc-brand"},{"title":"Register a 10DLC campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/campaign","href":"/api-reference/all-endpoints/compliance/register-a-10dlc-campaign-1"},{"title":"Get the org's combined 10DLC registration status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/status","href":"/api-reference/all-endpoints/compliance/get-the-orgs-combined-10dlc-registration-status"},{"title":"Pre-lint a 10DLC brand + campaign submission","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/preflight","href":"/api-reference/all-endpoints/compliance/pre-lint-a-10dlc-brand-+-campaign-submission"},{"title":"Decode a 10DLC rejection code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/decode-rejection","href":"/api-reference/all-endpoints/compliance/decode-a-10dlc-rejection-code"},{"title":"Get a 10DLC brand's TCR vetting score","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/brands/{id}/vetting","href":"/api-reference/all-endpoints/compliance/get-a-10dlc-brands-tcr-vetting-score"},{"title":"Get a 10DLC brand's carrier throughput envelope","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/brands/{id}/throughput","href":"/api-reference/all-endpoints/compliance/get-a-10dlc-brands-carrier-throughput-envelope"},{"title":"Request a re-vet of a registered brand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/brands/{id}/revet","href":"/api-reference/all-endpoints/compliance/request-a-re-vet-of-a-registered-brand"},{"title":"Get a 10DLC campaign's live carrier status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/campaigns/{id}/status","href":"/api-reference/all-endpoints/compliance/get-a-10dlc-campaigns-live-carrier-status"},{"title":"Get the 10DLC wizard's progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/wizard","href":"/api-reference/all-endpoints/compliance/get-the-10dlc-wizards-progress"},{"title":"Get the saved 10DLC wizard draft","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/10dlc/wizard/draft","href":"/api-reference/all-endpoints/compliance/get-the-saved-10dlc-wizard-draft"},{"title":"Partial-save the 10DLC wizard draft","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/10dlc/wizard/draft","href":"/api-reference/all-endpoints/compliance/partial-save-the-10dlc-wizard-draft"},{"title":"Reset the 10DLC wizard draft","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/10dlc/wizard/draft","href":"/api-reference/all-endpoints/compliance/reset-the-10dlc-wizard-draft"},{"title":"Send the wizard phone-verification OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/wizard/phone/send","href":"/api-reference/all-endpoints/compliance/send-the-wizard-phone-verification-otp"},{"title":"Confirm the wizard phone-verification OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/wizard/phone/confirm","href":"/api-reference/all-endpoints/compliance/confirm-the-wizard-phone-verification-otp"},{"title":"Lint the saved 10DLC wizard draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/wizard/preflight","href":"/api-reference/all-endpoints/compliance/lint-the-saved-10dlc-wizard-draft"},{"title":"Submit the wizard's brand and campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/10dlc/wizard/submit","href":"/api-reference/all-endpoints/compliance/submit-the-wizards-brand-and-campaign"},{"title":"Get preference-center config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/preference-center","href":"/api-reference/all-endpoints/compliance/get-preference-center-config"},{"title":"Save the preference-center config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/preference-center","href":"/api-reference/all-endpoints/compliance/save-the-preference-center-config"},{"title":"Mint a per-contact preference link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/preference-center/link","href":"/api-reference/all-endpoints/compliance/mint-a-per-contact-preference-link"},{"title":"List the organization's DSAR requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar","href":"/api-reference/all-endpoints/compliance/list-the-organizations-dsar-requests"},{"title":"File a data subject access request (DSAR)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dsar","href":"/api-reference/all-endpoints/compliance/file-a-data-subject-access-request-dsar"},{"title":"Record the identity-verification decision for a DSAR","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dsar/{id}/verification","href":"/api-reference/all-endpoints/compliance/record-the-identity-verification-decision-for-a-dsar"},{"title":"Withdraw an in-flight DSAR","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dsar/{id}/cancel","href":"/api-reference/all-endpoints/compliance/withdraw-an-in-flight-dsar"},{"title":"Get one DSAR request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar/{id}","href":"/api-reference/all-endpoints/compliance/get-one-dsar-request"},{"title":"Download the decrypted DSAR access export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar/{id}/decrypted","href":"/api-reference/all-endpoints/compliance/download-the-decrypted-dsar-access-export"},{"title":"List GDPR erasure requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar/erasure-requests","href":"/api-reference/all-endpoints/compliance/list-gdpr-erasure-requests"},{"title":"Cancel a pending erasure request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dsar/erasure-requests/{id}/cancel","href":"/api-reference/all-endpoints/compliance/cancel-a-pending-erasure-request"},{"title":"Issue the proof-of-deletion certificate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar/erasure-requests/{id}/certificate","href":"/api-reference/all-endpoints/compliance/issue-the-proof-of-deletion-certificate"},{"title":"List sla","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dsar/sla","href":"/api-reference/all-endpoints/compliance/list-sla"},{"title":"List compliance binder frameworks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/binder/frameworks","href":"/api-reference/all-endpoints/compliance/list-compliance-binder-frameworks"},{"title":"Generate a compliance binder evidence pack","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/binder/generate","href":"/api-reference/all-endpoints/compliance/generate-a-compliance-binder-evidence-pack"},{"title":"Get binder","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/binder/{jobId}","href":"/api-reference/all-endpoints/compliance/get-binder"},{"title":"List binder","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/binder","href":"/api-reference/all-endpoints/compliance/list-binder"},{"title":"List country-channel messaging rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/country-rules","href":"/api-reference/all-endpoints/compliance/list-country-channel-messaging-rules"},{"title":"Upsert a country-channel messaging rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/country-rules/{channel}/{country_code}","href":"/api-reference/all-endpoints/compliance/upsert-a-country-channel-messaging-rule"},{"title":"Sync country rules from an upstream feed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/country-rules/sync","href":"/api-reference/all-endpoints/compliance/sync-country-rules-from-an-upstream-feed"},{"title":"Get one use-case's compliance requirements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/requirements","href":"/api-reference/all-endpoints/compliance/get-one-use-cases-compliance-requirements"},{"title":"List compliance submission use-cases","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/use-cases","href":"/api-reference/all-endpoints/compliance/list-compliance-submission-use-cases"},{"title":"List compliance profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/compliance-profiles","href":"/api-reference/all-endpoints/compliance/list-compliance-profiles"},{"title":"Create a compliance profile draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/compliance-profiles","href":"/api-reference/all-endpoints/compliance/create-a-compliance-profile-draft"},{"title":"List eligible compliance profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/compliance-profiles/eligible","href":"/api-reference/all-endpoints/compliance/list-eligible-compliance-profiles"},{"title":"Get one compliance profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/compliance-profiles/{id}","href":"/api-reference/all-endpoints/compliance/get-one-compliance-profile"},{"title":"Delete a compliance profile","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/compliance-profiles/{id}","href":"/api-reference/all-endpoints/compliance/delete-a-compliance-profile"},{"title":"Edit a compliance profile draft","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/compliance/compliance-profiles/{id}","href":"/api-reference/all-endpoints/compliance/edit-a-compliance-profile-draft"},{"title":"List numbers bound to a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/compliance-profiles/{id}/numbers","href":"/api-reference/all-endpoints/compliance/list-numbers-bound-to-a-profile"},{"title":"Clone a compliance profile into a new draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/compliance-profiles/{id}/clone","href":"/api-reference/all-endpoints/compliance/clone-a-compliance-profile-into-a-new-draft"},{"title":"Set a profile's structured data","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/compliance-profiles/{id}/data","href":"/api-reference/all-endpoints/compliance/set-a-profiles-structured-data"},{"title":"Attach a document to a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/compliance-profiles/{id}/documents","href":"/api-reference/all-endpoints/compliance/attach-a-document-to-a-profile"},{"title":"Detach a document from a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/compliance-profiles/{id}/documents/{docId}","href":"/api-reference/all-endpoints/compliance/detach-a-document-from-a-profile"},{"title":"Submit a compliance profile to providers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/compliance-profiles/{id}/submit","href":"/api-reference/all-endpoints/compliance/submit-a-compliance-profile-to-providers"},{"title":"Refresh a profile's submission statuses","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/compliance-profiles/{id}/resync","href":"/api-reference/all-endpoints/compliance/refresh-a-profiles-submission-statuses"},{"title":"List tenant compliance documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/documents","href":"/api-reference/all-endpoints/compliance/list-tenant-compliance-documents"},{"title":"Upload a compliance document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/documents","href":"/api-reference/all-endpoints/compliance/upload-a-compliance-document"},{"title":"Delete a compliance document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/documents/{id}","href":"/api-reference/all-endpoints/compliance/delete-a-compliance-document"},{"title":"Get the tenant's AI disclosure settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/ai-disclosure","href":"/api-reference/all-endpoints/compliance/get-the-tenants-ai-disclosure-settings"},{"title":"Update the tenant's AI disclosure settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/ai-disclosure","href":"/api-reference/all-endpoints/compliance/update-the-tenants-ai-disclosure-settings"},{"title":"List registered Consent Managers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/managers","href":"/api-reference/all-endpoints/compliance/list-registered-consent-managers"},{"title":"Register a Consent Manager","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent/managers","href":"/api-reference/all-endpoints/compliance/register-a-consent-manager"},{"title":"Update or deactivate a Consent Manager","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/consent/managers/{id}","href":"/api-reference/all-endpoints/compliance/update-or-deactivate-a-consent-manager"},{"title":"Persist a signed consent receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent/receipts","href":"/api-reference/all-endpoints/compliance/persist-a-signed-consent-receipt"},{"title":"Verify a stored consent receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent/receipts/{id}/verify","href":"/api-reference/all-endpoints/compliance/verify-a-stored-consent-receipt"},{"title":"Record a consent opt-in or opt-out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent","href":"/api-reference/all-endpoints/compliance/record-a-consent-opt-in-or-opt-out"},{"title":"Get consent state for a contact and channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/lookup","href":"/api-reference/all-endpoints/compliance/get-consent-state-for-a-contact-and-channel"},{"title":"Get a contact's consent audit trail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/history","href":"/api-reference/all-endpoints/compliance/get-a-contacts-consent-audit-trail"},{"title":"List expiring opt-ins","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/expiring","href":"/api-reference/all-endpoints/compliance/list-expiring-opt-ins"},{"title":"List a call's recording-consent receipts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/recording-consent","href":"/api-reference/all-endpoints/compliance/list-a-calls-recording-consent-receipts"},{"title":"Capture per-call recording consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/recording-consent","href":"/api-reference/all-endpoints/compliance/capture-per-call-recording-consent"},{"title":"Evaluate the recording-consent gate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/recording-consent/verify","href":"/api-reference/all-endpoints/compliance/evaluate-the-recording-consent-gate"},{"title":"Withdraw recording consent (GDPR Art 7(3))","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/recording-consent/{callId}/revoke","href":"/api-reference/all-endpoints/compliance/withdraw-recording-consent-gdpr-art-73"},{"title":"Mint a consent-receipt integrity digest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/recording-consent/integrity","href":"/api-reference/all-endpoints/compliance/mint-a-consent-receipt-integrity-digest"},{"title":"Verify a consent-receipt integrity digest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/recording-consent/integrity/verify","href":"/api-reference/all-endpoints/compliance/verify-a-consent-receipt-integrity-digest"},{"title":"List a recording's voice signatures","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/voice-signatures","href":"/api-reference/all-endpoints/compliance/list-a-recordings-voice-signatures"},{"title":"Capture a voice signature on a recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/voice-signatures","href":"/api-reference/all-endpoints/compliance/capture-a-voice-signature-on-a-recording"},{"title":"Retrieve one voice-signature clip","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/voice-signatures/{signatureId}","href":"/api-reference/all-endpoints/compliance/retrieve-one-voice-signature-clip"},{"title":"Start a managed double opt-in (confirmed-consent) handshake","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent/double-opt-in","href":"/api-reference/all-endpoints/compliance/start-a-managed-double-opt-in-confirmed-consent-handshake"},{"title":"Confirm a managed double opt-in handshake from a reply","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/consent/double-opt-in/confirm","href":"/api-reference/all-endpoints/compliance/confirm-a-managed-double-opt-in-handshake-from-a-reply"},{"title":"Get the managed double opt-in handshake state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/double-opt-in/status","href":"/api-reference/all-endpoints/compliance/get-the-managed-double-opt-in-handshake-state"},{"title":"List baa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/baa","href":"/api-reference/all-endpoints/compliance/list-baa"},{"title":"List template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/baa/template","href":"/api-reference/all-endpoints/compliance/list-template"},{"title":"Require baa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/baa/require","href":"/api-reference/all-endpoints/compliance/require-baa"},{"title":"Execute baa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/baa/execute","href":"/api-reference/all-endpoints/compliance/execute-baa"},{"title":"Decline baa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/baa/decline","href":"/api-reference/all-endpoints/compliance/decline-baa"},{"title":"Revert baa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/baa/revert","href":"/api-reference/all-endpoints/compliance/revert-baa"},{"title":"List download","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/baa/download","href":"/api-reference/all-endpoints/compliance/list-download"},{"title":"List PHI-adjacent audience designations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/hipaa/phi-audiences","href":"/api-reference/all-endpoints/compliance/list-phi-adjacent-audience-designations"},{"title":"Replace PHI-adjacent audience designations","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/hipaa/phi-audiences","href":"/api-reference/all-endpoints/compliance/replace-phi-adjacent-audience-designations"},{"title":"Get the organization's DPA acceptance state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dpa","href":"/api-reference/all-endpoints/compliance/get-the-organizations-dpa-acceptance-state"},{"title":"Preview the DPA template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dpa/template","href":"/api-reference/all-endpoints/compliance/preview-the-dpa-template"},{"title":"Accept the organization's DPA (click-wrap e-sign)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dpa/accept","href":"/api-reference/all-endpoints/compliance/accept-the-organizations-dpa-click-wrap-e-sign"},{"title":"Get a signed download URL for the accepted DPA PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dpa/download","href":"/api-reference/all-endpoints/compliance/get-a-signed-download-url-for-the-accepted-dpa-pdf"},{"title":"Check DNC status for a phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dnc/check","href":"/api-reference/all-endpoints/compliance/check-dnc-status-for-a-phone-number"},{"title":"Scrub a list of phone numbers against DNC sources (bulk)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dnc/scrub","href":"/api-reference/all-endpoints/compliance/scrub-a-list-of-phone-numbers-against-dnc-sources-bulk"},{"title":"Whether bulk DNC scrub / pre-flight is available for the org","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dnc/availability","href":"/api-reference/all-endpoints/compliance/whether-bulk-dnc-scrub-pre-flight-is-available-for-the-org"},{"title":"Preview quiet-hours dispatch decision","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/quiet-hours/preview","href":"/api-reference/all-endpoints/compliance/preview-quiet-hours-dispatch-decision"},{"title":"Read the per-org RND-scrub opt-in flag","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/rnd/settings","href":"/api-reference/all-endpoints/compliance/read-the-per-org-rnd-scrub-opt-in-flag"},{"title":"Set the per-org RND-scrub opt-in flag","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/rnd/settings","href":"/api-reference/all-endpoints/compliance/set-the-per-org-rnd-scrub-opt-in-flag"},{"title":"Scrub a destination number against the FCC Reassigned Numbers Database","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/rnd/check","href":"/api-reference/all-endpoints/compliance/scrub-a-destination-number-against-the-fcc-reassigned-numbers-database"},{"title":"Read the per-org carrier-deactivation scrub opt-in flag","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/deactivations/settings","href":"/api-reference/all-endpoints/compliance/read-the-per-org-carrier-deactivation-scrub-opt-in-flag"},{"title":"Set the per-org carrier-deactivation scrub opt-in flag","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/deactivations/settings","href":"/api-reference/all-endpoints/compliance/set-the-per-org-carrier-deactivation-scrub-opt-in-flag"},{"title":"Check a single number against the carrier deactivation (churn) feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/deactivations/check","href":"/api-reference/all-endpoints/compliance/check-a-single-number-against-the-carrier-deactivation-churn-feed"},{"title":"Scrub a batch of numbers against the carrier deactivation (churn) feed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/deactivations/scrub","href":"/api-reference/all-endpoints/compliance/scrub-a-batch-of-numbers-against-the-carrier-deactivation-churn-feed"},{"title":"Get compliance emergency-stop status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/emergency-stop","href":"/api-reference/all-endpoints/compliance/get-compliance-emergency-stop-status"},{"title":"Activate the org-wide compliance emergency stop","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/emergency-stop/activate","href":"/api-reference/all-endpoints/compliance/activate-the-org-wide-compliance-emergency-stop"},{"title":"Deactivate the org-wide compliance emergency stop","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/emergency-stop/deactivate","href":"/api-reference/all-endpoints/compliance/deactivate-the-org-wide-compliance-emergency-stop"},{"title":"List fraud alerts raised on your account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/fraud-reviews","href":"/api-reference/all-endpoints/compliance/list-fraud-alerts-raised-on-your-account"},{"title":"Export Traffic Fraud Shield chargeback evidence (CSV)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/fraud-reviews/chargeback-evidence.csv","href":"/api-reference/all-endpoints/compliance/export-traffic-fraud-shield-chargeback-evidence-csv"},{"title":"Get your fraud-review triage thresholds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/fraud-reviews/settings","href":"/api-reference/all-endpoints/compliance/get-your-fraud-review-triage-thresholds"},{"title":"Configure your fraud-review triage thresholds","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/fraud-reviews/settings","href":"/api-reference/all-endpoints/compliance/configure-your-fraud-review-triage-thresholds"},{"title":"Get one fraud alert on your account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/fraud-reviews/{id}","href":"/api-reference/all-endpoints/compliance/get-one-fraud-alert-on-your-account"},{"title":"Acknowledge (triage) a fraud alert","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/fraud-reviews/{id}/acknowledge","href":"/api-reference/all-endpoints/compliance/acknowledge-triage-a-fraud-alert"},{"title":"Dismiss a fraud alert","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/fraud-reviews/{id}/dismiss","href":"/api-reference/all-endpoints/compliance/dismiss-a-fraud-alert"},{"title":"List ITG traceback cases","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/traceback","href":"/api-reference/all-endpoints/compliance/list-itg-traceback-cases"},{"title":"Log an inbound ITG traceback request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/traceback","href":"/api-reference/all-endpoints/compliance/log-an-inbound-itg-traceback-request"},{"title":"Get one ITG traceback case","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/traceback/{id}","href":"/api-reference/all-endpoints/compliance/get-one-itg-traceback-case"},{"title":"Acknowledge an ITG traceback case","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/traceback/{id}/acknowledge","href":"/api-reference/all-endpoints/compliance/acknowledge-an-itg-traceback-case"},{"title":"File a response/disposition for an ITG traceback case","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/traceback/{id}/respond","href":"/api-reference/all-endpoints/compliance/file-a-responsedisposition-for-an-itg-traceback-case"},{"title":"List CALEA lawful-intercept orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/calea/intercepts","href":"/api-reference/all-endpoints/compliance/list-calea-lawful-intercept-orders"},{"title":"Provision a CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/calea/intercepts","href":"/api-reference/all-endpoints/compliance/provision-a-calea-lawful-intercept-order"},{"title":"Get one CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/calea/intercepts/{id}","href":"/api-reference/all-endpoints/compliance/get-one-calea-lawful-intercept-order"},{"title":"Authorize a CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/calea/intercepts/{id}/authorize","href":"/api-reference/all-endpoints/compliance/authorize-a-calea-lawful-intercept-order"},{"title":"Activate a CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/calea/intercepts/{id}/activate","href":"/api-reference/all-endpoints/compliance/activate-a-calea-lawful-intercept-order"},{"title":"Suspend a CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/calea/intercepts/{id}/suspend","href":"/api-reference/all-endpoints/compliance/suspend-a-calea-lawful-intercept-order"},{"title":"Terminate a CALEA lawful-intercept order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/calea/intercepts/{id}/terminate","href":"/api-reference/all-endpoints/compliance/terminate-a-calea-lawful-intercept-order"},{"title":"Get the org's STIR/SHAKEN attestation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/attestation/policy","href":"/api-reference/all-endpoints/compliance/get-the-orgs-stirshaken-attestation-policy"},{"title":"Set the org's STIR/SHAKEN attestation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/attestation/policy","href":"/api-reference/all-endpoints/compliance/set-the-orgs-stirshaken-attestation-policy"},{"title":"Get the org's STIR/SHAKEN attestation posture snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/attestation/posture","href":"/api-reference/all-endpoints/compliance/get-the-orgs-stirshaken-attestation-posture-snapshot"},{"title":"List the org's STIR/SHAKEN delegate certificates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/attestation/delegate-certs","href":"/api-reference/all-endpoints/compliance/list-the-orgs-stirshaken-delegate-certificates"},{"title":"Register a STIR/SHAKEN delegate certificate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/attestation/delegate-certs","href":"/api-reference/all-endpoints/compliance/register-a-stirshaken-delegate-certificate"},{"title":"Revoke a STIR/SHAKEN delegate certificate","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/attestation/delegate-certs/{id}","href":"/api-reference/all-endpoints/compliance/revoke-a-stirshaken-delegate-certificate"},{"title":"Get the org's FCC Robocall Mitigation Database registration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/rmd","href":"/api-reference/all-endpoints/compliance/get-the-orgs-fcc-robocall-mitigation-database-registration"},{"title":"Create or update the draft RMD registration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd","href":"/api-reference/all-endpoints/compliance/create-or-update-the-draft-rmd-registration"},{"title":"Submit the RMD registration to the FCC database","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd/submit","href":"/api-reference/all-endpoints/compliance/submit-the-rmd-registration-to-the-fcc-database"},{"title":"Mark the RMD registration active/certified","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd/certify","href":"/api-reference/all-endpoints/compliance/mark-the-rmd-registration-activecertified"},{"title":"Flag the RMD registration as needing remediation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd/remediation","href":"/api-reference/all-endpoints/compliance/flag-the-rmd-registration-as-needing-remediation"},{"title":"Resolve an RMD remediation and re-certify","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd/resolve","href":"/api-reference/all-endpoints/compliance/resolve-an-rmd-remediation-and-re-certify"},{"title":"Withdraw the RMD registration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/rmd/withdraw","href":"/api-reference/all-endpoints/compliance/withdraw-the-rmd-registration"},{"title":"Set the call-time RMD origination enforcement mode","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/rmd/enforcement","href":"/api-reference/all-endpoints/compliance/set-the-call-time-rmd-origination-enforcement-mode"},{"title":"Bulk import a CSV of opt-outs into the suppression list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/suppression-list/import","href":"/api-reference/all-endpoints/compliance/bulk-import-a-csv-of-opt-outs-into-the-suppression-list"},{"title":"Export the consent proof-of-record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/consent/export","href":"/api-reference/all-endpoints/compliance/export-the-consent-proof-of-record"},{"title":"Export the suppression list ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/suppression-list/export","href":"/api-reference/all-endpoints/compliance/export-the-suppression-list-ledger"},{"title":"List DLT principal entities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dlt-india/principal-entities","href":"/api-reference/all-endpoints/compliance/list-dlt-principal-entities"},{"title":"Register a DLT principal entity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dlt-india/principal-entities","href":"/api-reference/all-endpoints/compliance/register-a-dlt-principal-entity"},{"title":"List DLT (India) headers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dlt-india/headers","href":"/api-reference/all-endpoints/compliance/list-dlt-india-headers"},{"title":"Register a DLT (India) header","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dlt-india/headers","href":"/api-reference/all-endpoints/compliance/register-a-dlt-india-header"},{"title":"List DLT (India) content templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dlt-india/content-templates","href":"/api-reference/all-endpoints/compliance/list-dlt-india-content-templates"},{"title":"Register a DLT (India) content template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dlt-india/content-templates","href":"/api-reference/all-endpoints/compliance/register-a-dlt-india-content-template"},{"title":"List DLT (India) consent templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dlt-india/consent-templates","href":"/api-reference/all-endpoints/compliance/list-dlt-india-consent-templates"},{"title":"Register a DLT (India) consent template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dlt-india/consent-templates","href":"/api-reference/all-endpoints/compliance/register-a-dlt-india-consent-template"},{"title":"Read the DLT (India) registration nudge","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dlt-india/nudge","href":"/api-reference/all-endpoints/compliance/read-the-dlt-india-registration-nudge"},{"title":"Dismiss the DLT (India) registration nudge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/dlt-india/nudge/dismiss","href":"/api-reference/all-endpoints/compliance/dismiss-the-dlt-india-registration-nudge"},{"title":"List sender-id-registrations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/sender-id-registrations","href":"/api-reference/all-endpoints/compliance/list-sender-id-registrations"},{"title":"Sender-id-registrations compliance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/sender-id-registrations","href":"/api-reference/all-endpoints/compliance/sender-id-registrations-compliance"},{"title":"Get the org's data-residency / region-pinning config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/data-residency","href":"/api-reference/all-endpoints/compliance/get-the-orgs-data-residency-region-pinning-config"},{"title":"Pin or update the data-residency region","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/data-residency","href":"/api-reference/all-endpoints/compliance/pin-or-update-the-data-residency-region"},{"title":"Lock the data-residency pin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/data-residency/lock","href":"/api-reference/all-endpoints/compliance/lock-the-data-residency-pin"},{"title":"Unlock the data-residency pin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/data-residency/unlock","href":"/api-reference/all-endpoints/compliance/unlock-the-data-residency-pin"},{"title":"Get the org's per-domain data-retention policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/data-retention","href":"/api-reference/all-endpoints/compliance/get-the-orgs-per-domain-data-retention-policy"},{"title":"Set the per-domain data-retention policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/data-retention","href":"/api-reference/all-endpoints/compliance/set-the-per-domain-data-retention-policy"},{"title":"List data-breach incidents with register summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/breach-incidents","href":"/api-reference/all-endpoints/compliance/list-data-breach-incidents-with-register-summary"},{"title":"Open a data-breach incident","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/breach-incidents","href":"/api-reference/all-endpoints/compliance/open-a-data-breach-incident"},{"title":"Get a single breach incident","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/breach-incidents/{id}","href":"/api-reference/all-endpoints/compliance/get-a-single-breach-incident"},{"title":"Update a breach incident or advance its lifecycle status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/compliance/breach-incidents/{id}","href":"/api-reference/all-endpoints/compliance/update-a-breach-incident-or-advance-its-lifecycle-status"},{"title":"Record an Art.33/34 notification for a breach incident","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/breach-incidents/{id}/notifications","href":"/api-reference/all-endpoints/compliance/record-an-art3334-notification-for-a-breach-incident"},{"title":"Produce the Art.33/34 72-hour notification attestation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/breach-incidents/{id}/attestation","href":"/api-reference/all-endpoints/compliance/produce-the-art3334-72-hour-notification-attestation"},{"title":"List processing activities with ROPA register summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/processing-activities","href":"/api-reference/all-endpoints/compliance/list-processing-activities-with-ropa-register-summary"},{"title":"Intake a processing activity into the ROPA register","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/processing-activities","href":"/api-reference/all-endpoints/compliance/intake-a-processing-activity-into-the-ropa-register"},{"title":"Export the Art.30 processing inventory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/processing-activities/inventory","href":"/api-reference/all-endpoints/compliance/export-the-art30-processing-inventory"},{"title":"Get a single processing activity with its DPIA screening","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/processing-activities/{id}","href":"/api-reference/all-endpoints/compliance/get-a-single-processing-activity-with-its-dpia-screening"},{"title":"Update a processing activity or advance its lifecycle status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/compliance/processing-activities/{id}","href":"/api-reference/all-endpoints/compliance/update-a-processing-activity-or-advance-its-lifecycle-status"},{"title":"Record the GDPR Art.35 DPIA risk assessment for an activity","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/processing-activities/{id}/dpia","href":"/api-reference/all-endpoints/compliance/record-the-gdpr-art35-dpia-risk-assessment-for-an-activity"},{"title":"Get the DPO (Art.37) + EU/UK representative (Art.27) designation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dpo-representative","href":"/api-reference/all-endpoints/compliance/get-the-dpo-art37-+-euuk-representative-art27-designation"},{"title":"Declare the DPO (Art.37) + EU/UK representative (Art.27)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/dpo-representative","href":"/api-reference/all-endpoints/compliance/declare-the-dpo-art37-+-euuk-representative-art27"},{"title":"Export the DPO / Art.27 representative attestation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/dpo-representative/attestation","href":"/api-reference/all-endpoints/compliance/export-the-dpo-art27-representative-attestation"},{"title":"CPNI compliance posture (consent + certification summaries)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni","href":"/api-reference/all-endpoints/compliance/cpni-compliance-posture-consent-+-certification-summaries"},{"title":"List CPNI marketing-use consent decisions with summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni/consent","href":"/api-reference/all-endpoints/compliance/list-cpni-marketing-use-consent-decisions-with-summary"},{"title":"Record a CPNI marketing-use consent decision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/cpni/consent","href":"/api-reference/all-endpoints/compliance/record-a-cpni-marketing-use-consent-decision"},{"title":"Get a single CPNI consent record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni/consent/{id}","href":"/api-reference/all-endpoints/compliance/get-a-single-cpni-consent-record"},{"title":"List annual CPNI §64.2009(e) certifications with summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni/certifications","href":"/api-reference/all-endpoints/compliance/list-annual-cpni-§642009e-certifications-with-summary"},{"title":"Open an annual CPNI §64.2009(e) certification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/cpni/certifications","href":"/api-reference/all-endpoints/compliance/open-an-annual-cpni-§642009e-certification"},{"title":"Get a single CPNI certification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni/certifications/{id}","href":"/api-reference/all-endpoints/compliance/get-a-single-cpni-certification"},{"title":"Update a CPNI certification or advance its lifecycle","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/compliance/cpni/certifications/{id}","href":"/api-reference/all-endpoints/compliance/update-a-cpni-certification-or-advance-its-lifecycle"},{"title":"Produce the §64.2009(e) certification attestation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/cpni/certifications/{id}/attestation","href":"/api-reference/all-endpoints/compliance/produce-the-§642009e-certification-attestation"},{"title":"Get the org's BYOK / customer-managed-key config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/byok","href":"/api-reference/all-endpoints/compliance/get-the-orgs-byok-customer-managed-key-config"},{"title":"Register a customer-managed encryption key","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/byok","href":"/api-reference/all-endpoints/compliance/register-a-customer-managed-encryption-key"},{"title":"Activate a pending customer-managed key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/byok/activate","href":"/api-reference/all-endpoints/compliance/activate-a-pending-customer-managed-key"},{"title":"Rotate the customer-managed key reference","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/byok/rotate","href":"/api-reference/all-endpoints/compliance/rotate-the-customer-managed-key-reference"},{"title":"Revoke the customer-managed key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/byok/revoke","href":"/api-reference/all-endpoints/compliance/revoke-the-customer-managed-key"},{"title":"Get the org's SMS/voice compliance archival policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/archival","href":"/api-reference/all-endpoints/compliance/get-the-orgs-smsvoice-compliance-archival-policy"},{"title":"Upsert the SMS/voice compliance archival policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/archival","href":"/api-reference/all-endpoints/compliance/upsert-the-smsvoice-compliance-archival-policy"},{"title":"Run an SMS/voice archival export for a window","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/archival/export","href":"/api-reference/all-endpoints/compliance/run-an-smsvoice-archival-export-for-a-window"},{"title":"List the org's third-party archive-vendor connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/archive-connectors","href":"/api-reference/all-endpoints/compliance/list-the-orgs-third-party-archive-vendor-connectors"},{"title":"Check an archive-vendor connector's pre-activation readiness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/archive-connectors/{vendor}/readiness","href":"/api-reference/all-endpoints/compliance/check-an-archive-vendor-connectors-pre-activation-readiness"},{"title":"Preview an archive-vendor connector's readiness from draft form fields","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/archive-connectors/{vendor}/readiness/preview","href":"/api-reference/all-endpoints/compliance/preview-an-archive-vendor-connectors-readiness-from-draft-form-fields"},{"title":"Register or update a third-party archive-vendor connector","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/archive-connectors/{vendor}","href":"/api-reference/all-endpoints/compliance/register-or-update-a-third-party-archive-vendor-connector"},{"title":"Remove a third-party archive-vendor connector","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/archive-connectors/{vendor}","href":"/api-reference/all-endpoints/compliance/remove-a-third-party-archive-vendor-connector"},{"title":"Activate (or resume) an archive-vendor connector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/archive-connectors/{vendor}/activate","href":"/api-reference/all-endpoints/compliance/activate-or-resume-an-archive-vendor-connector"},{"title":"Pause an archive-vendor connector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/archive-connectors/{vendor}/pause","href":"/api-reference/all-endpoints/compliance/pause-an-archive-vendor-connector"},{"title":"List the org's configured SIEM sink connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/siem-sinks","href":"/api-reference/all-endpoints/compliance/list-the-orgs-configured-siem-sink-connectors"},{"title":"Register or update a SIEM sink connector","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/siem-sinks/{type}","href":"/api-reference/all-endpoints/compliance/register-or-update-a-siem-sink-connector"},{"title":"Remove a SIEM sink connector","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/compliance/siem-sinks/{type}","href":"/api-reference/all-endpoints/compliance/remove-a-siem-sink-connector"},{"title":"Activate (or resume) a SIEM sink connector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/siem-sinks/{type}/activate","href":"/api-reference/all-endpoints/compliance/activate-or-resume-a-siem-sink-connector"},{"title":"Pause a SIEM sink connector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/siem-sinks/{type}/pause","href":"/api-reference/all-endpoints/compliance/pause-a-siem-sink-connector"},{"title":"Get conversation legal-hold state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/legal-hold/conversations/{id}","href":"/api-reference/all-endpoints/compliance/get-conversation-legal-hold-state"},{"title":"Place or release a conversation legal hold","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/legal-hold/conversations/{id}","href":"/api-reference/all-endpoints/compliance/place-or-release-a-conversation-legal-hold"},{"title":"List vertical compliance activation bundles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/vertical-bundles","href":"/api-reference/all-endpoints/compliance/list-vertical-compliance-activation-bundles"},{"title":"Get one vertical bundle's full manifest","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/vertical-bundles/{key}","href":"/api-reference/all-endpoints/compliance/get-one-vertical-bundles-full-manifest"},{"title":"Activate a vertical compliance bundle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/compliance/vertical-bundles/{key}/activate","href":"/api-reference/all-endpoints/compliance/activate-a-vertical-compliance-bundle"},{"title":"Get a vertical bundle activation state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/vertical-bundles/activations/{profileId}","href":"/api-reference/all-endpoints/compliance/get-a-vertical-bundle-activation-state"},{"title":"Toggle a bundle go-live checklist step","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/compliance/vertical-bundles/activations/{profileId}/checklist/{stepId}","href":"/api-reference/all-endpoints/compliance/toggle-a-bundle-go-live-checklist-step"},{"title":"Organization-wide messaging compliance health score","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/health","href":"/api-reference/all-endpoints/compliance/organization-wide-messaging-compliance-health-score"},{"title":"Per-number messaging compliance health scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/health/numbers","href":"/api-reference/all-endpoints/compliance/per-number-messaging-compliance-health-scores"},{"title":"Per-campaign messaging compliance health scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/health/campaigns","href":"/api-reference/all-endpoints/compliance/per-campaign-messaging-compliance-health-scores"},{"title":"Read hosted preference page data","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/preferences/{token}","href":"/api-reference/all-endpoints/compliance/read-hosted-preference-page-data"},{"title":"Update preferences from the hosted page","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/compliance/preferences/{token}","href":"/api-reference/all-endpoints/compliance/update-preferences-from-the-hosted-page"},{"title":"Get conversation-level recording legal-hold tally","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/conversation/{conversationId}/legal-hold","href":"/api-reference/all-endpoints/compliance/get-conversation-level-recording-legal-hold-tally"},{"title":"Place or release legal hold on all recordings of a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/recordings/conversation/{conversationId}/legal-hold","href":"/api-reference/all-endpoints/compliance/place-or-release-legal-hold-on-all-recordings-of-a-conversation"},{"title":"Get Orbit's public signed-link (actor-token) JWKS","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/.well-known/actor-token-jwks.json","href":"/api-reference/all-endpoints/compliance/get-orbits-public-signed-link-actor-token-jwks"},{"title":"List audit-export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/audit-export","href":"/api-reference/all-endpoints/compliance/list-audit-export"},{"title":"Get audit-export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/audit-export/{jobId}","href":"/api-reference/all-endpoints/compliance/get-audit-export"},{"title":"List verify","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/compliance/audit-export/{jobId}/verify","href":"/api-reference/all-endpoints/compliance/list-verify"}]},{"group":"Surveys","pages":[{"title":"Open the survey response page","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/surveys/{token}","href":"/api-reference/all-endpoints/surveys/open-the-survey-response-page"},{"title":"Submit a survey response","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/surveys/{token}/submit","href":"/api-reference/all-endpoints/surveys/submit-a-survey-response"},{"title":"List all survey templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys","href":"/api-reference/all-endpoints/surveys/list-all-survey-templates"},{"title":"Create a survey template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/surveys","href":"/api-reference/all-endpoints/surveys/create-a-survey-template"},{"title":"Queue- / agent-level CSAT / NPS scorecards across answered survey responses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/scorecards","href":"/api-reference/all-endpoints/surveys/queue--agent-level-csat-nps-scorecards-across-answered-survey-responses"},{"title":"Get a single survey template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/{id}","href":"/api-reference/all-endpoints/surveys/get-a-single-survey-template"},{"title":"Delete a survey template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/surveys/{id}","href":"/api-reference/all-endpoints/surveys/delete-a-survey-template"},{"title":"Update a survey template","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/surveys/{id}","href":"/api-reference/all-endpoints/surveys/update-a-survey-template"},{"title":"Send a survey to an audience (contact, list, or segment)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/surveys/{id}/send","href":"/api-reference/all-endpoints/surveys/send-a-survey-to-an-audience-contact-list-or-segment"},{"title":"List contacts eligible for a reminder wave — sent this survey, not yet responded, stale for at least ?stale_hours= (default 24)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/{id}/non-responders","href":"/api-reference/all-endpoints/surveys/list-contacts-eligible-for-a-reminder-wave-—-sent-this-survey-not-yet-responded-stale-for-at-least-?stale_hours=-default-24"},{"title":"Send a reminder wave to a survey's non-responders (CXaaS response-rate lever) — re-dispatches through the same channel check, dedupe, and fatigue cap as the original send","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/surveys/{id}/remind","href":"/api-reference/all-endpoints/surveys/send-a-reminder-wave-to-a-surveys-non-responders-cxaas-response-rate-lever-—-re-dispatches-through-the-same-channel-check-dedupe-and-fatigue-cap-as-the-original-send"},{"title":"Aggregate survey rollup — avg score, NPS score, response rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/{id}/results","href":"/api-reference/all-endpoints/surveys/aggregate-survey-rollup-—-avg-score-nps-score-response-rate"},{"title":"Voice-of-Customer analytics over verbatim comments — sentiment, themes, drivers, NPS trend over time. Optionally scoped by channel / agent_id / team_id / segment_id for per-breakout scorecards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/{id}/voc","href":"/api-reference/all-endpoints/surveys/voice-of-customer-analytics-over-verbatim-comments-—-sentiment-themes-drivers-nps-trend-over-time-optionally-scoped-by-channel-agent_id-team_id-segment_id-for-per-breakout-scorecards"},{"title":"Benchmark this survey's CSAT / NPS / CES score against industry-vertical peer percentiles — percentile rank, quartile rating, and delta vs the industry median. Pick the peer group with ?vertical=","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/surveys/{id}/benchmark","href":"/api-reference/all-endpoints/surveys/benchmark-this-surveys-csat-nps-ces-score-against-industry-vertical-peer-percentiles-—-percentile-rank-quartile-rating-and-delta-vs-the-industry-median-pick-the-peer-group-with-?vertical="}]},{"group":"Agentic Commerce","pages":[{"title":"ACP storefront discovery manifest (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/commerce/acp/{storefrontId}/.well-known/agentic-commerce","href":"/api-reference/all-endpoints/agentic-commerce/acp-storefront-discovery-manifest-public"},{"title":"ACP hosted product feed (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/commerce/acp/{storefrontId}/feed","href":"/api-reference/all-endpoints/agentic-commerce/acp-hosted-product-feed-public"},{"title":"Open a public ACP checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/commerce/acp/{storefrontId}/checkout","href":"/api-reference/all-endpoints/agentic-commerce/open-a-public-acp-checkout-session"},{"title":"Update a public ACP checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/commerce/acp/{storefrontId}/checkout/update","href":"/api-reference/all-endpoints/agentic-commerce/update-a-public-acp-checkout-session"},{"title":"Complete a public ACP checkout under a verified agent mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/commerce/acp/{storefrontId}/checkout/complete","href":"/api-reference/all-endpoints/agentic-commerce/complete-a-public-acp-checkout-under-a-verified-agent-mandate"}]},{"group":"MCP","pages":[{"title":"Hosted MCP server discovery manifest (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/mcp/.well-known/mcp.json","href":"/api-reference/all-endpoints/mcp/hosted-mcp-server-discovery-manifest-public"}]},{"group":"Integrations","pages":[{"title":"List nango","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/webhooks/nango","href":"/api-reference/all-endpoints/integrations/list-nango"},{"title":"Nango webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/nango","href":"/api-reference/all-endpoints/integrations/nango-webhooks"},{"title":"Segment webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/segment","href":"/api-reference/all-endpoints/integrations/segment-webhooks"},{"title":"Receive a HubSpot webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/hubspot","href":"/api-reference/all-endpoints/integrations/receive-a-hubspot-webhook-event"},{"title":"Receive a Calendly webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/calendly","href":"/api-reference/all-endpoints/integrations/receive-a-calendly-webhook-event"},{"title":"Shopify webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/shopify","href":"/api-reference/all-endpoints/integrations/shopify-webhooks"},{"title":"Salesforce webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/salesforce","href":"/api-reference/all-endpoints/integrations/salesforce-webhooks"},{"title":"Slack webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/slack","href":"/api-reference/all-endpoints/integrations/slack-webhooks"},{"title":"Intercom webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/webhooks/intercom","href":"/api-reference/all-endpoints/integrations/intercom-webhooks"},{"title":"Complete the Slack OAuth install","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/slack/oauth/callback","href":"/api-reference/all-endpoints/integrations/complete-the-slack-oauth-install"},{"title":"Complete the Intercom OAuth install","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/intercom/oauth/callback","href":"/api-reference/all-endpoints/integrations/complete-the-intercom-oauth-install"},{"title":"List the available integration catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/catalog","href":"/api-reference/all-endpoints/integrations/list-the-available-integration-catalog"},{"title":"List per-integration connection statuses for the org","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/connections","href":"/api-reference/all-endpoints/integrations/list-per-integration-connection-statuses-for-the-org"},{"title":"Disconnect an integration connection by key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/integrations/connections/{uniqueKey}","href":"/api-reference/all-endpoints/integrations/disconnect-an-integration-connection-by-key"},{"title":"Start the direct Intercom OAuth install","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/intercom/oauth/start","href":"/api-reference/all-endpoints/integrations/start-the-direct-intercom-oauth-install"},{"title":"Start the direct Slack OAuth install","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/slack/oauth/start","href":"/api-reference/all-endpoints/integrations/start-the-direct-slack-oauth-install"},{"title":"List Slack channels and the current notification channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/slack/channels","href":"/api-reference/all-endpoints/integrations/list-slack-channels-and-the-current-notification-channel"},{"title":"Pin the Slack channel Orbit posts notifications to","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/integrations/slack/notifications-channel","href":"/api-reference/all-endpoints/integrations/pin-the-slack-channel-orbit-posts-notifications-to"},{"title":"List integrations with the org's connection status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations","href":"/api-reference/all-endpoints/integrations/list-integrations-with-the-orgs-connection-status"},{"title":"Start a connect flow for an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/connect","href":"/api-reference/all-endpoints/integrations/start-a-connect-flow-for-an-integration"},{"title":"Get connection and sync status for an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/{id}/status","href":"/api-reference/all-endpoints/integrations/get-connection-and-sync-status-for-an-integration"},{"title":"Disconnect an integration and revoke its connection","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/integrations/{id}/disconnect","href":"/api-reference/all-endpoints/integrations/disconnect-an-integration-and-revoke-its-connection"},{"title":"Trigger an immediate data sync for an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/{id}/sync","href":"/api-reference/all-endpoints/integrations/trigger-an-immediate-data-sync-for-an-integration"},{"title":"Retrieve synced records for an integration model","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/{id}/data","href":"/api-reference/all-endpoints/integrations/retrieve-synced-records-for-an-integration-model"},{"title":"Invoke a named action on an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/{id}/actions/{name}","href":"/api-reference/all-endpoints/integrations/invoke-a-named-action-on-an-integration"},{"title":"Get an integration's feature preference flags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/{id}/features","href":"/api-reference/all-endpoints/integrations/get-an-integrations-feature-preference-flags"},{"title":"Update an integration's feature preference flags","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/integrations/{id}/features","href":"/api-reference/all-endpoints/integrations/update-an-integrations-feature-preference-flags"},{"title":"List Segment inbound sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/integrations/segment/sources","href":"/api-reference/all-endpoints/integrations/list-segment-inbound-sources"},{"title":"Create a Segment inbound source","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/segment/sources","href":"/api-reference/all-endpoints/integrations/create-a-segment-inbound-source"},{"title":"Delete a Segment inbound source","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/integrations/segment/sources/{id}","href":"/api-reference/all-endpoints/integrations/delete-a-segment-inbound-source"},{"title":"Rotate a Segment source's inbound secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/segment/sources/{id}/rotate-secret","href":"/api-reference/all-endpoints/integrations/rotate-a-segment-sources-inbound-secret"},{"title":"Send a test event to a Segment source","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/segment/sources/{id}/test","href":"/api-reference/all-endpoints/integrations/send-a-test-event-to-a-segment-source"},{"title":"Connect woocommerce","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/woocommerce/connect","href":"/api-reference/all-endpoints/integrations/connect-woocommerce"},{"title":"Delete disconnect","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/integrations/woocommerce/disconnect","href":"/api-reference/all-endpoints/integrations/delete-disconnect"},{"title":"Request a new integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/integrations/requests","href":"/api-reference/all-endpoints/integrations/request-a-new-integration"}]},{"group":"Webhooks","pages":[{"title":"Events slack","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/slack/events","href":"/api-reference/all-endpoints/webhooks/events-slack"},{"title":"List instagram","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/inbound/instagram","href":"/api-reference/all-endpoints/webhooks/list-instagram"},{"title":"Instagram inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/instagram","href":"/api-reference/all-endpoints/webhooks/instagram-inbound"},{"title":"List messenger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/inbound/messenger","href":"/api-reference/all-endpoints/webhooks/list-messenger"},{"title":"Messenger inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/messenger","href":"/api-reference/all-endpoints/webhooks/messenger-inbound"},{"title":"Clerk webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/clerk","href":"/api-reference/all-endpoints/webhooks/clerk-webhooks"},{"title":"Sms dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/sms","href":"/api-reference/all-endpoints/webhooks/sms-dlr"},{"title":"Jasmin dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/jasmin","href":"/api-reference/all-endpoints/webhooks/jasmin-dlr"},{"title":"Whatsapp dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/whatsapp","href":"/api-reference/all-endpoints/webhooks/whatsapp-dlr"},{"title":"Create email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/email/{tenantId}","href":"/api-reference/all-endpoints/webhooks/create-email"},{"title":"List email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/dlr/email","href":"/api-reference/all-endpoints/webhooks/list-email"},{"title":"Email dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/email","href":"/api-reference/all-endpoints/webhooks/email-dlr"},{"title":"Telnyx dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/telnyx","href":"/api-reference/all-endpoints/webhooks/telnyx-dlr"},{"title":"Dotgo dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/dotgo","href":"/api-reference/all-endpoints/webhooks/dotgo-dlr"},{"title":"Create dotgo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/dotgo/{routingToken}","href":"/api-reference/all-endpoints/webhooks/create-dotgo"},{"title":"Viber dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/viber","href":"/api-reference/all-endpoints/webhooks/viber-dlr"},{"title":"Fax dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/fax","href":"/api-reference/all-endpoints/webhooks/fax-dlr"},{"title":"Instagram dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/instagram","href":"/api-reference/all-endpoints/webhooks/instagram-dlr"},{"title":"Messenger dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/messenger","href":"/api-reference/all-endpoints/webhooks/messenger-dlr"},{"title":"Telegram dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/telegram","href":"/api-reference/all-endpoints/webhooks/telegram-dlr"},{"title":"Line dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/line","href":"/api-reference/all-endpoints/webhooks/line-dlr"},{"title":"Kakao dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/kakao","href":"/api-reference/all-endpoints/webhooks/kakao-dlr"},{"title":"Zalo dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/zalo","href":"/api-reference/all-endpoints/webhooks/zalo-dlr"},{"title":"Wechat dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/wechat","href":"/api-reference/all-endpoints/webhooks/wechat-dlr"},{"title":"Discord dlr","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlr/discord","href":"/api-reference/all-endpoints/webhooks/discord-dlr"},{"title":"Sms inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/sms","href":"/api-reference/all-endpoints/webhooks/sms-inbound"},{"title":"Whatsapp inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/whatsapp","href":"/api-reference/all-endpoints/webhooks/whatsapp-inbound"},{"title":"Viber inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/viber","href":"/api-reference/all-endpoints/webhooks/viber-inbound"},{"title":"Rcs inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/rcs","href":"/api-reference/all-endpoints/webhooks/rcs-inbound"},{"title":"Create rcs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/rcs/{routingToken}","href":"/api-reference/all-endpoints/webhooks/create-rcs"},{"title":"List meta","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/inbound/meta","href":"/api-reference/all-endpoints/webhooks/list-meta"},{"title":"Create tenantId","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/email/{tenantId}/{tenantToken}","href":"/api-reference/all-endpoints/webhooks/create-tenantid"},{"title":"Email inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/email","href":"/api-reference/all-endpoints/webhooks/email-inbound"},{"title":"Line inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/line","href":"/api-reference/all-endpoints/webhooks/line-inbound"},{"title":"Fax inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/fax","href":"/api-reference/all-endpoints/webhooks/fax-inbound"},{"title":"Telegram inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/telegram","href":"/api-reference/all-endpoints/webhooks/telegram-inbound"},{"title":"Kakao inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/kakao","href":"/api-reference/all-endpoints/webhooks/kakao-inbound"},{"title":"Zalo inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/zalo","href":"/api-reference/all-endpoints/webhooks/zalo-inbound"},{"title":"Wechat inbound","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/inbound/wechat","href":"/api-reference/all-endpoints/webhooks/wechat-inbound"},{"title":"Network-events webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/network-events","href":"/api-reference/all-endpoints/webhooks/network-events-webhooks"},{"title":"Voice-noop telnyx","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/telnyx/voice-noop","href":"/api-reference/all-endpoints/webhooks/voice-noop-telnyx"},{"title":"Tcr webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/tcr","href":"/api-reference/all-endpoints/webhooks/tcr-webhooks"},{"title":"Number-orders telnyx","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/telnyx/number-orders","href":"/api-reference/all-endpoints/webhooks/number-orders-telnyx"},{"title":"Telnyx-events webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/telnyx-events","href":"/api-reference/all-endpoints/webhooks/telnyx-events-webhooks"},{"title":"Tfv-twilio webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/tfv-twilio","href":"/api-reference/all-endpoints/webhooks/tfv-twilio-webhooks"},{"title":"Create address-verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/didww/address-verification/{token}","href":"/api-reference/all-endpoints/webhooks/create-address-verification"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks","href":"/api-reference/all-endpoints/webhooks/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks","href":"/api-reference/all-endpoints/webhooks/register-a-webhook-endpoint"},{"title":"Send an ad-hoc test webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/test","href":"/api-reference/all-endpoints/webhooks/send-an-ad-hoc-test-webhook"},{"title":"List dead-lettered webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/dlq","href":"/api-reference/all-endpoints/webhooks/list-dead-lettered-webhook-deliveries"},{"title":"Get a dead-lettered delivery's full detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/dlq/{deliveryId}","href":"/api-reference/all-endpoints/webhooks/get-a-dead-lettered-deliverys-full-detail"},{"title":"Bulk-replay dead-lettered deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlq/bulk-replay","href":"/api-reference/all-endpoints/webhooks/bulk-replay-dead-lettered-deliveries"},{"title":"Requeue a dead-lettered delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/dlq/{deliveryId}/requeue","href":"/api-reference/all-endpoints/webhooks/requeue-a-dead-lettered-delivery"},{"title":"List webhook event schemas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/event-schemas","href":"/api-reference/all-endpoints/webhooks/list-webhook-event-schemas"},{"title":"List inbound-event normalization catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/inbound-events","href":"/api-reference/all-endpoints/webhooks/list-inbound-event-normalization-catalog"},{"title":"List webhook egress IPs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/egress-ips","href":"/api-reference/all-endpoints/webhooks/list-webhook-egress-ips"},{"title":"List webhook events (tenant timeline)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/events","href":"/api-reference/all-endpoints/webhooks/list-webhook-events-tenant-timeline"},{"title":"Get webhook reliability rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/reliability","href":"/api-reference/all-endpoints/webhooks/get-webhook-reliability-rollup"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}","href":"/api-reference/all-endpoints/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/webhooks/{id}","href":"/api-reference/all-endpoints/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/webhooks/{id}","href":"/api-reference/all-endpoints/webhooks/delete-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/rotate-secret","href":"/api-reference/all-endpoints/webhooks/rotate-a-webhook-signing-secret"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}/deliveries","href":"/api-reference/all-endpoints/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}/deliveries/{deliveryId}","href":"/api-reference/all-endpoints/webhooks/get-a-webhook-delivery"},{"title":"Retry a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/deliveries/{deliveryId}/retry","href":"/api-reference/all-endpoints/webhooks/retry-a-webhook-delivery"},{"title":"Test a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/test","href":"/api-reference/all-endpoints/webhooks/test-a-webhook-endpoint"},{"title":"Pause a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/pause","href":"/api-reference/all-endpoints/webhooks/pause-a-webhook-endpoint"},{"title":"Resume a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/resume","href":"/api-reference/all-endpoints/webhooks/resume-a-webhook-endpoint"},{"title":"Replay a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/deliveries/{deliveryId}/replay","href":"/api-reference/all-endpoints/webhooks/replay-a-webhook-delivery"},{"title":"Fire a synthetic test event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/test-fire","href":"/api-reference/all-endpoints/webhooks/fire-a-synthetic-test-event"},{"title":"Initiate a webhook secret rotation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/rotation/initiate","href":"/api-reference/all-endpoints/webhooks/initiate-a-webhook-secret-rotation"},{"title":"Get webhook rotation status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}/rotation/status","href":"/api-reference/all-endpoints/webhooks/get-webhook-rotation-status"},{"title":"Complete a webhook secret rotation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/rotation/complete","href":"/api-reference/all-endpoints/webhooks/complete-a-webhook-secret-rotation"},{"title":"Cancel a webhook secret rotation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/rotation/cancel","href":"/api-reference/all-endpoints/webhooks/cancel-a-webhook-secret-rotation"},{"title":"Get webhook endpoint health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}/health","href":"/api-reference/all-endpoints/webhooks/get-webhook-endpoint-health"},{"title":"Preview a bulk webhook replay","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/replay-range/preview","href":"/api-reference/all-endpoints/webhooks/preview-a-bulk-webhook-replay"},{"title":"Start a bulk webhook replay","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/webhooks/{id}/replay-range","href":"/api-reference/all-endpoints/webhooks/start-a-bulk-webhook-replay"},{"title":"Get bulk replay job status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/webhooks/{id}/replay-range/{jobId}","href":"/api-reference/all-endpoints/webhooks/get-bulk-replay-job-status"}]},{"group":"Video","pages":[{"title":"Webhook video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/webhook","href":"/api-reference/all-endpoints/video/webhook-video"},{"title":"Create redeem","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/invites/{inviteToken}/redeem","href":"/api-reference/all-endpoints/video/create-redeem"},{"title":"Create chat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms/{id}/chat","href":"/api-reference/all-endpoints/video/create-chat"},{"title":"List rooms-scheduled","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled","href":"/api-reference/all-endpoints/video/list-rooms-scheduled"},{"title":"Rooms-scheduled video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled","href":"/api-reference/all-endpoints/video/rooms-scheduled-video"},{"title":"List limits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/limits","href":"/api-reference/all-endpoints/video/list-limits"},{"title":"Get rooms-scheduled","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}","href":"/api-reference/all-endpoints/video/get-rooms-scheduled"},{"title":"Patch rooms-scheduled","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/rooms-scheduled/{id}","href":"/api-reference/all-endpoints/video/patch-rooms-scheduled"},{"title":"List activity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/activity","href":"/api-reference/all-endpoints/video/list-activity"},{"title":"List speakers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/speakers","href":"/api-reference/all-endpoints/video/list-speakers"},{"title":"Create join","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/join","href":"/api-reference/all-endpoints/video/create-join"},{"title":"Create end","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/end","href":"/api-reference/all-endpoints/video/create-end"},{"title":"Start recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/start","href":"/api-reference/all-endpoints/video/start-recording"},{"title":"List recording","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/recording","href":"/api-reference/all-endpoints/video/list-recording"},{"title":"Stop recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/stop","href":"/api-reference/all-endpoints/video/stop-recording"},{"title":"Pause recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/pause","href":"/api-reference/all-endpoints/video/pause-recording"},{"title":"Resume recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/resume","href":"/api-reference/all-endpoints/video/resume-recording"},{"title":"Rtmp egress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/egress/rtmp","href":"/api-reference/all-endpoints/video/rtmp-egress"},{"title":"Delete rtmp","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/egress/rtmp/{egressId}","href":"/api-reference/all-endpoints/video/delete-rtmp"},{"title":"Stream egress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/egress/stream","href":"/api-reference/all-endpoints/video/stream-egress"},{"title":"Delete stream","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/egress/stream/{egressId}","href":"/api-reference/all-endpoints/video/delete-stream"},{"title":"Hls egress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/egress/hls","href":"/api-reference/all-endpoints/video/hls-egress"},{"title":"Delete hls","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/egress/hls/{egressId}","href":"/api-reference/all-endpoints/video/delete-hls"},{"title":"Dash egress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/egress/dash","href":"/api-reference/all-endpoints/video/dash-egress"},{"title":"Delete dash","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/egress/dash/{egressId}","href":"/api-reference/all-endpoints/video/delete-dash"},{"title":"Participants egress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/egress/participants","href":"/api-reference/all-endpoints/video/participants-egress"},{"title":"Delete participants","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/egress/participants","href":"/api-reference/all-endpoints/video/delete-participants"},{"title":"List livestream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/livestream","href":"/api-reference/all-endpoints/video/list-livestream"},{"title":"List dvr","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/livestream/dvr","href":"/api-reference/all-endpoints/video/list-dvr"},{"title":"List dial-in","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/dial-in","href":"/api-reference/all-endpoints/video/list-dial-in"},{"title":"List room-system","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/room-system","href":"/api-reference/all-endpoints/video/list-room-system"},{"title":"List ingress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/ingress","href":"/api-reference/all-endpoints/video/list-ingress"},{"title":"Create ingress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/ingress","href":"/api-reference/all-endpoints/video/create-ingress"},{"title":"Delete ingress","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/ingress/{ingressId}","href":"/api-reference/all-endpoints/video/delete-ingress"},{"title":"Create dial-out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/dial-out","href":"/api-reference/all-endpoints/video/create-dial-out"},{"title":"Create dispatch-agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/dispatch-agent","href":"/api-reference/all-endpoints/video/create-dispatch-agent"},{"title":"Create media-fork","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/media-fork","href":"/api-reference/all-endpoints/video/create-media-fork"},{"title":"Delete media-fork","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/media-fork/{forkId}","href":"/api-reference/all-endpoints/video/delete-media-fork"},{"title":"List invites","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/invites","href":"/api-reference/all-endpoints/video/list-invites"},{"title":"Create invites","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/invites","href":"/api-reference/all-endpoints/video/create-invites"},{"title":"Delete invites","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/invites/{inviteId}","href":"/api-reference/all-endpoints/video/delete-invites"},{"title":"List transcripts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/transcripts","href":"/api-reference/all-endpoints/video/list-transcripts"},{"title":"Delete transcripts","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/transcripts","href":"/api-reference/all-endpoints/video/delete-transcripts"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/transcripts/export","href":"/api-reference/all-endpoints/video/list-export"},{"title":"Patch transcripts","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/rooms-scheduled/{id}/transcripts/{transcriptId}","href":"/api-reference/all-endpoints/video/patch-transcripts"},{"title":"Create ask","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/ask","href":"/api-reference/all-endpoints/video/create-ask"},{"title":"List chat","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/chat","href":"/api-reference/all-endpoints/video/list-chat"},{"title":"Create chat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/chat","href":"/api-reference/all-endpoints/video/create-chat-1"},{"title":"Delete chat","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/chat","href":"/api-reference/all-endpoints/video/delete-chat"},{"title":"Create kick","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/kick","href":"/api-reference/all-endpoints/video/create-kick"},{"title":"Create mute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/mute","href":"/api-reference/all-endpoints/video/create-mute"},{"title":"Create unmute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/unmute","href":"/api-reference/all-endpoints/video/create-unmute"},{"title":"Create ban","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/ban","href":"/api-reference/all-endpoints/video/create-ban"},{"title":"Delete ban","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/participants/{identity}/ban","href":"/api-reference/all-endpoints/video/delete-ban"},{"title":"List bans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/bans","href":"/api-reference/all-endpoints/video/list-bans"},{"title":"Create recording-consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/recording-consent","href":"/api-reference/all-endpoints/video/create-recording-consent"},{"title":"List recording-consents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/recording-consents","href":"/api-reference/all-endpoints/video/list-recording-consents"},{"title":"Exclude-participant recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/exclude-participant","href":"/api-reference/all-endpoints/video/exclude-participant-recording"},{"title":"Unexclude-participant recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/recording/unexclude-participant","href":"/api-reference/all-endpoints/video/unexclude-participant-recording"},{"title":"List exclusions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/recording/exclusions","href":"/api-reference/all-endpoints/video/list-exclusions"},{"title":"Create mute-all","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/mute-all","href":"/api-reference/all-endpoints/video/create-mute-all"},{"title":"Create lock","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/lock","href":"/api-reference/all-endpoints/video/create-lock"},{"title":"Create spotlight","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/spotlight","href":"/api-reference/all-endpoints/video/create-spotlight"},{"title":"Delete spotlight","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/spotlight","href":"/api-reference/all-endpoints/video/delete-spotlight"},{"title":"Create branding","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/branding","href":"/api-reference/all-endpoints/video/create-branding"},{"title":"Delete branding","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/branding","href":"/api-reference/all-endpoints/video/delete-branding"},{"title":"Create broadcast","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/broadcast","href":"/api-reference/all-endpoints/video/create-broadcast"},{"title":"Create tier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/tier","href":"/api-reference/all-endpoints/video/create-tier"},{"title":"List roles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/participants/roles","href":"/api-reference/all-endpoints/video/list-roles"},{"title":"Create role","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/role","href":"/api-reference/all-endpoints/video/create-role"},{"title":"Create receive-control","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/participants/{identity}/receive-control","href":"/api-reference/all-endpoints/video/create-receive-control"},{"title":"Create breakouts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/breakouts","href":"/api-reference/all-endpoints/video/create-breakouts"},{"title":"Create move","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/breakouts/{childRoomId}/move/{identity}","href":"/api-reference/all-endpoints/video/create-move"},{"title":"Create waiting-room","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/waiting-room","href":"/api-reference/all-endpoints/video/create-waiting-room"},{"title":"Read the SSO restriction policy and arming eligibility","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/sso-policy","href":"/api-reference/all-endpoints/video/read-the-sso-restriction-policy-and-arming-eligibility"},{"title":"Create sso-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/sso-policy","href":"/api-reference/all-endpoints/video/create-sso-policy"},{"title":"Create admit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/waiting-room/admit/{identity}","href":"/api-reference/all-endpoints/video/create-admit"},{"title":"Create deny","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/waiting-room/deny/{identity}","href":"/api-reference/all-endpoints/video/create-deny"},{"title":"Create hand-raise","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/hand-raise","href":"/api-reference/all-endpoints/video/create-hand-raise"},{"title":"Create hand-lower","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/hand-lower","href":"/api-reference/all-endpoints/video/create-hand-lower"},{"title":"List hand-queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/hand-queue","href":"/api-reference/all-endpoints/video/list-hand-queue"},{"title":"Clear hand-queue","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/hand-queue/clear","href":"/api-reference/all-endpoints/video/clear-hand-queue"},{"title":"Create reactions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/reactions","href":"/api-reference/all-endpoints/video/create-reactions"},{"title":"Create polls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/polls","href":"/api-reference/all-endpoints/video/create-polls"},{"title":"Vote polls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/polls/vote","href":"/api-reference/all-endpoints/video/vote-polls"},{"title":"Close polls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/polls/close","href":"/api-reference/all-endpoints/video/close-polls"},{"title":"Create qa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/qa","href":"/api-reference/all-endpoints/video/create-qa"},{"title":"Answer qa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/qa/answer","href":"/api-reference/all-endpoints/video/answer-qa"},{"title":"Open whiteboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/whiteboard/open","href":"/api-reference/all-endpoints/video/open-whiteboard"},{"title":"Draw whiteboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/whiteboard/draw","href":"/api-reference/all-endpoints/video/draw-whiteboard"},{"title":"Clear whiteboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/whiteboard/clear","href":"/api-reference/all-endpoints/video/clear-whiteboard"},{"title":"Close whiteboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/whiteboard/close","href":"/api-reference/all-endpoints/video/close-whiteboard"},{"title":"Delete chat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/chat/delete","href":"/api-reference/all-endpoints/video/delete-chat-1"},{"title":"Clear chat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/chat/clear","href":"/api-reference/all-endpoints/video/clear-chat"},{"title":"Create chat-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/chat-policy","href":"/api-reference/all-endpoints/video/create-chat-policy"},{"title":"Start watch-together","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/watch-together/start","href":"/api-reference/all-endpoints/video/start-watch-together"},{"title":"Control watch-together","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/watch-together/control","href":"/api-reference/all-endpoints/video/control-watch-together"},{"title":"Stop watch-together","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/watch-together/stop","href":"/api-reference/all-endpoints/video/stop-watch-together"},{"title":"List watch-together","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/watch-together","href":"/api-reference/all-endpoints/video/list-watch-together"},{"title":"List registration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/registration","href":"/api-reference/all-endpoints/video/list-registration"},{"title":"Update registration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/video/rooms-scheduled/{id}/registration","href":"/api-reference/all-endpoints/video/update-registration"},{"title":"Create registrants","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/registrants","href":"/api-reference/all-endpoints/video/create-registrants"},{"title":"Delete registrants","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}","href":"/api-reference/all-endpoints/video/delete-registrants"},{"title":"Patch registrants","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}","href":"/api-reference/all-endpoints/video/patch-registrants"},{"title":"Create check-in","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}/check-in","href":"/api-reference/all-endpoints/video/create-check-in"},{"title":"List simulive","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/simulive","href":"/api-reference/all-endpoints/video/list-simulive"},{"title":"Update simulive","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/video/rooms-scheduled/{id}/simulive","href":"/api-reference/all-endpoints/video/update-simulive"},{"title":"List playout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-scheduled/{id}/simulive/playout","href":"/api-reference/all-endpoints/video/list-playout"},{"title":"Cancel simulive","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms-scheduled/{id}/simulive/cancel","href":"/api-reference/all-endpoints/video/cancel-simulive"},{"title":"Ephemeral-key captions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/captions/ephemeral-key","href":"/api-reference/all-endpoints/video/ephemeral-key-captions"},{"title":"Translate captions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/captions/translate","href":"/api-reference/all-endpoints/video/translate-captions"},{"title":"Create segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/captions/{name}/segment","href":"/api-reference/all-endpoints/video/create-segment"},{"title":"List capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/captions/capabilities","href":"/api-reference/all-endpoints/video/list-capabilities"},{"title":"Interpretation video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/interpretation","href":"/api-reference/all-endpoints/video/interpretation-video"},{"title":"List background-library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/background-library","href":"/api-reference/all-endpoints/video/list-background-library"},{"title":"Background-library video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/background-library","href":"/api-reference/all-endpoints/video/background-library-video"},{"title":"Delete background-library","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/background-library/{assetId}","href":"/api-reference/all-endpoints/video/delete-background-library"},{"title":"Patch background-library","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/background-library/{assetId}","href":"/api-reference/all-endpoints/video/patch-background-library"},{"title":"List room-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/room-templates","href":"/api-reference/all-endpoints/video/list-room-templates"},{"title":"Room-templates video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/room-templates","href":"/api-reference/all-endpoints/video/room-templates-video"},{"title":"Get room-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/room-templates/{id}","href":"/api-reference/all-endpoints/video/get-room-templates"},{"title":"Delete room-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/room-templates/{id}","href":"/api-reference/all-endpoints/video/delete-room-templates"},{"title":"Patch room-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/room-templates/{id}","href":"/api-reference/all-endpoints/video/patch-room-templates"},{"title":"Create instantiate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/room-templates/{id}/instantiate","href":"/api-reference/all-endpoints/video/create-instantiate"},{"title":"List avatar-agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/avatar-agents","href":"/api-reference/all-endpoints/video/list-avatar-agents"},{"title":"Avatar-agents video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/avatar-agents","href":"/api-reference/all-endpoints/video/avatar-agents-video"},{"title":"Delete avatar-agents","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/avatar-agents/{id}","href":"/api-reference/all-endpoints/video/delete-avatar-agents"},{"title":"Patch avatar-agents","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/avatar-agents/{id}","href":"/api-reference/all-endpoints/video/patch-avatar-agents"},{"title":"List join-plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/avatar-agents/{id}/join-plan","href":"/api-reference/all-endpoints/video/list-join-plan"},{"title":"List pre-meeting-briefing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/pre-meeting-briefing","href":"/api-reference/all-endpoints/video/list-pre-meeting-briefing"},{"title":"Update pre-meeting-briefing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/video/pre-meeting-briefing","href":"/api-reference/all-endpoints/video/update-pre-meeting-briefing"},{"title":"List avatar-video-renders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/avatar-video-renders","href":"/api-reference/all-endpoints/video/list-avatar-video-renders"},{"title":"Avatar-video-renders video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/avatar-video-renders","href":"/api-reference/all-endpoints/video/avatar-video-renders-video"},{"title":"Get avatar-video-renders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/avatar-video-renders/{id}","href":"/api-reference/all-endpoints/video/get-avatar-video-renders"},{"title":"Delete avatar-video-renders","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/avatar-video-renders/{id}","href":"/api-reference/all-endpoints/video/delete-avatar-video-renders"},{"title":"Patch avatar-video-renders","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/video/avatar-video-renders/{id}","href":"/api-reference/all-endpoints/video/patch-avatar-video-renders"},{"title":"Verify avatar-video-renders","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/avatar-video-renders/verify","href":"/api-reference/all-endpoints/video/verify-avatar-video-renders"},{"title":"List chapter-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/recordings/chapter-analytics","href":"/api-reference/all-endpoints/video/list-chapter-analytics"},{"title":"Room usage analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms-analytics/usage","href":"/api-reference/all-endpoints/video/room-usage-analytics"},{"title":"List preflight","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/preflight","href":"/api-reference/all-endpoints/video/list-preflight"},{"title":"Get connection-quality","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/connection-quality/{name}","href":"/api-reference/all-endpoints/video/get-connection-quality"},{"title":"Create connection-quality","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/connection-quality/{name}","href":"/api-reference/all-endpoints/video/create-connection-quality"},{"title":"List stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/connection-quality/{name}/participants/{identity}/stats","href":"/api-reference/all-endpoints/video/list-stats"},{"title":"List report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/connection-quality/{name}/report","href":"/api-reference/all-endpoints/video/list-report"},{"title":"Get media-diagnostics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/media-diagnostics/{name}","href":"/api-reference/all-endpoints/video/get-media-diagnostics"},{"title":"Create media-diagnostics","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/media-diagnostics/{name}","href":"/api-reference/all-endpoints/video/create-media-diagnostics"},{"title":"List engagement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms/{name}/sessions/{sessionId}/engagement","href":"/api-reference/all-endpoints/video/list-engagement"},{"title":"Create engagement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms/{name}/sessions/{sessionId}/engagement","href":"/api-reference/all-endpoints/video/create-engagement"},{"title":"List media-metrics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms/{name}/sessions/{sessionId}/media-metrics","href":"/api-reference/all-endpoints/video/list-media-metrics"},{"title":"Create media-metrics","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms/{name}/sessions/{sessionId}/media-metrics","href":"/api-reference/all-endpoints/video/create-media-metrics"},{"title":"Create heartbeat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/broadcast-viewership/{name}/heartbeat","href":"/api-reference/all-endpoints/video/create-heartbeat"},{"title":"Get broadcast-viewership","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/broadcast-viewership/{name}","href":"/api-reference/all-endpoints/video/get-broadcast-viewership"},{"title":"List report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/broadcast-viewership/{name}/report","href":"/api-reference/all-endpoints/video/list-report-1"},{"title":"Create cues","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/broadcast-captions/{name}/cues","href":"/api-reference/all-endpoints/video/create-cues"},{"title":"List subtitles.vtt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/broadcast-captions/{name}/subtitles.vtt","href":"/api-reference/all-endpoints/video/list-subtitlesvtt"},{"title":"List languages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/broadcast-captions/{name}/languages","href":"/api-reference/all-endpoints/video/list-languages"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/sessions","href":"/api-reference/all-endpoints/video/list-sessions"},{"title":"Get sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/sessions/{id}","href":"/api-reference/all-endpoints/video/get-sessions"},{"title":"Create summary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/sessions/{id}/summary","href":"/api-reference/all-endpoints/video/create-summary"},{"title":"List qa-score","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/sessions/{id}/qa-score","href":"/api-reference/all-endpoints/video/list-qa-score"},{"title":"Create qa-score","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/sessions/{id}/qa-score","href":"/api-reference/all-endpoints/video/create-qa-score"},{"title":"List rooms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms","href":"/api-reference/all-endpoints/video/list-rooms"},{"title":"Rooms video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms","href":"/api-reference/all-endpoints/video/rooms-video"},{"title":"Get rooms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/video/rooms/{name}","href":"/api-reference/all-endpoints/video/get-rooms"},{"title":"Delete rooms","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/video/rooms/{name}","href":"/api-reference/all-endpoints/video/delete-rooms"},{"title":"Create token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/video/rooms/{name}/token","href":"/api-reference/all-endpoints/video/create-token"}]},{"group":"Voice","pages":[{"title":"Receive or orbit-media SIP disposition webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-webhook","href":"/api-reference/all-endpoints/voice/receive-or-orbit-media-sip-disposition-webhooks"},{"title":"Get ivr-flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/internal/ivr-flows/{id}","href":"/api-reference/all-endpoints/voice/get-ivr-flows"},{"title":"Dialog-info blf","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/internal/blf/dialog-info","href":"/api-reference/all-endpoints/voice/dialog-info-blf"},{"title":"List config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/internal/live-interpretation/{id}/config","href":"/api-reference/all-endpoints/voice/list-config"},{"title":"Patch config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/internal/live-interpretation/{id}/config","href":"/api-reference/all-endpoints/voice/patch-config"},{"title":"Create live-interpretation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/internal/live-interpretation/{id}","href":"/api-reference/all-endpoints/voice/create-live-interpretation"},{"title":"Create detected-language","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/internal/live-interpretation/{id}/detected-language","href":"/api-reference/all-endpoints/voice/create-detected-language"},{"title":"List config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/internal/rtt/{id}/config","href":"/api-reference/all-endpoints/voice/list-config-1"},{"title":"Patch config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/internal/rtt/{id}/config","href":"/api-reference/all-endpoints/voice/patch-config-1"},{"title":"Get rtt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/internal/rtt/{id}","href":"/api-reference/all-endpoints/voice/get-rtt"},{"title":"Create rtt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/internal/rtt/{id}","href":"/api-reference/all-endpoints/voice/create-rtt"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls","href":"/api-reference/all-endpoints/voice/list-calls"},{"title":"Calls voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls","href":"/api-reference/all-endpoints/voice/calls-voice"},{"title":"List dialing-restrictions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dialing-restrictions","href":"/api-reference/all-endpoints/voice/list-dialing-restrictions"},{"title":"Update dialing-restrictions","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/dialing-restrictions","href":"/api-reference/all-endpoints/voice/update-dialing-restrictions"},{"title":"List skill-proficiency-decay","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/skill-proficiency-decay","href":"/api-reference/all-endpoints/voice/list-skill-proficiency-decay"},{"title":"Update skill-proficiency-decay","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/skill-proficiency-decay","href":"/api-reference/all-endpoints/voice/update-skill-proficiency-decay"},{"title":"List max-call-duration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/max-call-duration","href":"/api-reference/all-endpoints/voice/list-max-call-duration"},{"title":"Update max-call-duration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/max-call-duration","href":"/api-reference/all-endpoints/voice/update-max-call-duration"},{"title":"List acd-auto-answer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/acd-auto-answer","href":"/api-reference/all-endpoints/voice/list-acd-auto-answer"},{"title":"Update acd-auto-answer","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/acd-auto-answer","href":"/api-reference/all-endpoints/voice/update-acd-auto-answer"},{"title":"List shared-speed-dial","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/shared-speed-dial","href":"/api-reference/all-endpoints/voice/list-shared-speed-dial"},{"title":"Update shared-speed-dial","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/shared-speed-dial","href":"/api-reference/all-endpoints/voice/update-shared-speed-dial"},{"title":"List affinity-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/affinity-routing","href":"/api-reference/all-endpoints/voice/list-affinity-routing"},{"title":"Update affinity-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/affinity-routing","href":"/api-reference/all-endpoints/voice/update-affinity-routing"},{"title":"List attribute-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/attribute-routing","href":"/api-reference/all-endpoints/voice/list-attribute-routing"},{"title":"Update attribute-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/attribute-routing","href":"/api-reference/all-endpoints/voice/update-attribute-routing"},{"title":"List sip-max-registrations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-max-registrations","href":"/api-reference/all-endpoints/voice/list-sip-max-registrations"},{"title":"Update sip-max-registrations","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/sip-max-registrations","href":"/api-reference/all-endpoints/voice/update-sip-max-registrations"},{"title":"List dialer-abandon-ceiling","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dialer-abandon-ceiling","href":"/api-reference/all-endpoints/voice/list-dialer-abandon-ceiling"},{"title":"Update dialer-abandon-ceiling","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/dialer-abandon-ceiling","href":"/api-reference/all-endpoints/voice/update-dialer-abandon-ceiling"},{"title":"List dial-plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dial-plan","href":"/api-reference/all-endpoints/voice/list-dial-plan"},{"title":"Update dial-plan","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/dial-plan","href":"/api-reference/all-endpoints/voice/update-dial-plan"},{"title":"List emergency-notification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/emergency-notification","href":"/api-reference/all-endpoints/voice/list-emergency-notification"},{"title":"Update emergency-notification","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/emergency-notification","href":"/api-reference/all-endpoints/voice/update-emergency-notification"},{"title":"List emergency-routing-config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/emergency-routing-config","href":"/api-reference/all-endpoints/voice/list-emergency-routing-config"},{"title":"Update emergency-routing-config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/emergency-routing-config","href":"/api-reference/all-endpoints/voice/update-emergency-routing-config"},{"title":"List emergency-drill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/emergency-drill","href":"/api-reference/all-endpoints/voice/list-emergency-drill"},{"title":"Update emergency-drill","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/emergency-drill","href":"/api-reference/all-endpoints/voice/update-emergency-drill"},{"title":"List aggregate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/aggregate","href":"/api-reference/all-endpoints/voice/list-aggregate"},{"title":"List search","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/search","href":"/api-reference/all-endpoints/voice/list-search"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/export","href":"/api-reference/all-endpoints/voice/list-export"},{"title":"List aggregates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/quality/aggregates","href":"/api-reference/all-endpoints/voice/list-aggregates"},{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/quality/carriers","href":"/api-reference/all-endpoints/voice/list-carriers"},{"title":"List worst-calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/quality/worst-calls","href":"/api-reference/all-endpoints/voice/list-worst-calls"},{"title":"List collection-status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/quality/collection-status","href":"/api-reference/all-endpoints/voice/list-collection-status"},{"title":"List vaqi","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/vaqi","href":"/api-reference/all-endpoints/voice/list-vaqi"},{"title":"List coverage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/coverage","href":"/api-reference/all-endpoints/voice/list-coverage"},{"title":"Mint a browser softphone access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/softphone/token","href":"/api-reference/all-endpoints/voice/mint-a-browser-softphone-access-token"},{"title":"Token agent-test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agent-test/token","href":"/api-reference/all-endpoints/voice/token-agent-test"},{"title":"Publisher rtc","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/rtc/publisher","href":"/api-reference/all-endpoints/voice/publisher-rtc"},{"title":"Delete publisher","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/rtc/publisher/{name}","href":"/api-reference/all-endpoints/voice/delete-publisher"},{"title":"List transcript-stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agent-test/transcript-stream","href":"/api-reference/all-endpoints/voice/list-transcript-stream"},{"title":"Originate an outbound call from the browser softphone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/softphone/dial","href":"/api-reference/all-endpoints/voice/originate-an-outbound-call-from-the-browser-softphone"},{"title":"Callback calls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/callback","href":"/api-reference/all-endpoints/voice/callback-calls"},{"title":"List clones","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/clones","href":"/api-reference/all-endpoints/voice/list-clones"},{"title":"Clones voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/clones","href":"/api-reference/all-endpoints/voice/clones-voice"},{"title":"List capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/clones/capabilities","href":"/api-reference/all-endpoints/voice/list-capabilities"},{"title":"Design clones","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/clones/design","href":"/api-reference/all-endpoints/voice/design-clones"},{"title":"Upload clones","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/clones/upload","href":"/api-reference/all-endpoints/voice/upload-clones"},{"title":"Delete clones","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/clones/{id}","href":"/api-reference/all-endpoints/voice/delete-clones"},{"title":"Create watermark","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/clones/{id}/watermark","href":"/api-reference/all-endpoints/voice/create-watermark"},{"title":"Verify watermark","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/clones/watermark/verify","href":"/api-reference/all-endpoints/voice/verify-watermark"},{"title":"Get calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}","href":"/api-reference/all-endpoints/voice/get-calls"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/transcript/stream","href":"/api-reference/all-endpoints/voice/list-stream"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/rtt/stream","href":"/api-reference/all-endpoints/voice/list-stream-1"},{"title":"Relay an agent real-time text (RTT/TTY) line to the caller","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/rtt/send","href":"/api-reference/all-endpoints/voice/relay-an-agent-real-time-text-rtttty-line-to-the-caller"},{"title":"Translate transcript","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/transcript/translate","href":"/api-reference/all-endpoints/voice/translate-transcript"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/agent-assist/stream","href":"/api-reference/all-endpoints/voice/list-stream-2"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/compliance/stream","href":"/api-reference/all-endpoints/voice/list-stream-3"},{"title":"List playbooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/playbooks","href":"/api-reference/all-endpoints/voice/list-playbooks"},{"title":"Update playbooks","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/playbooks","href":"/api-reference/all-endpoints/voice/update-playbooks"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/playbook/stream","href":"/api-reference/all-endpoints/voice/list-stream-4"},{"title":"List adherence","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/playbook/adherence","href":"/api-reference/all-endpoints/voice/list-adherence"},{"title":"Record playbook-card adherence for a live call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/playbook/adherence","href":"/api-reference/all-endpoints/voice/record-playbook-card-adherence-for-a-live-call"},{"title":"Mint a short-lived transcript SSE ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/transcript/ticket","href":"/api-reference/all-endpoints/voice/mint-a-short-lived-transcript-sse-ticket"},{"title":"Escalate a live call to an inbox ticket with AI context","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/escalate-to-ticket","href":"/api-reference/all-endpoints/voice/escalate-a-live-call-to-an-inbox-ticket-with-ai-context"},{"title":"Execute a one-click agent-assist action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/agent-assist/execute-action","href":"/api-reference/all-endpoints/voice/execute-a-one-click-agent-assist-action"},{"title":"Generate AI call summary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/summary","href":"/api-reference/all-endpoints/voice/generate-ai-call-summary"},{"title":"Queue-level AI digest from cached per-call summaries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/digest","href":"/api-reference/all-endpoints/voice/queue-level-ai-digest-from-cached-per-call-summaries"},{"title":"Update softphone in-call notes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/calls/{id}/notes","href":"/api-reference/all-endpoints/voice/update-softphone-in-call-notes"},{"title":"Create hangup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/hangup","href":"/api-reference/all-endpoints/voice/create-hangup"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/transfer","href":"/api-reference/all-endpoints/voice/create-transfer"},{"title":"Create accept","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/accept","href":"/api-reference/all-endpoints/voice/create-accept"},{"title":"Create decline","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/decline","href":"/api-reference/all-endpoints/voice/create-decline"},{"title":"Create skip","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/skip","href":"/api-reference/all-endpoints/voice/create-skip"},{"title":"Create mute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/mute","href":"/api-reference/all-endpoints/voice/create-mute"},{"title":"Create unmute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/unmute","href":"/api-reference/all-endpoints/voice/create-unmute"},{"title":"Create hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/hold","href":"/api-reference/all-endpoints/voice/create-hold"},{"title":"Create unhold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/unhold","href":"/api-reference/all-endpoints/voice/create-unhold"},{"title":"Create dtmf","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/dtmf","href":"/api-reference/all-endpoints/voice/create-dtmf"},{"title":"Start recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/start","href":"/api-reference/all-endpoints/voice/start-recording"},{"title":"Stop recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/stop","href":"/api-reference/all-endpoints/voice/stop-recording"},{"title":"Pause a mid-call recording (PCI/HIPAA two-party-consent control)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/pause","href":"/api-reference/all-endpoints/voice/pause-a-mid-call-recording-pcihipaa-two-party-consent-control"},{"title":"Resume a paused mid-call recording (PCI/HIPAA two-party-consent control)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/resume","href":"/api-reference/all-endpoints/voice/resume-a-paused-mid-call-recording-pcihipaa-two-party-consent-control"},{"title":"Begin agent-assisted secure payment (PCI DTMF capture)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/secure-payment/start","href":"/api-reference/all-endpoints/voice/begin-agent-assisted-secure-payment-pci-dtmf-capture"},{"title":"Complete agent-assisted secure payment capture","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/secure-payment/complete","href":"/api-reference/all-endpoints/voice/complete-agent-assisted-secure-payment-capture"},{"title":"Cancel agent-assisted secure payment capture","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/secure-payment/cancel","href":"/api-reference/all-endpoints/voice/cancel-agent-assisted-secure-payment-capture"},{"title":"Create warm-transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/warm-transfer","href":"/api-reference/all-endpoints/voice/create-warm-transfer"},{"title":"Complete warm-transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/warm-transfer/complete","href":"/api-reference/all-endpoints/voice/complete-warm-transfer"},{"title":"Cancel warm-transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/warm-transfer/cancel","href":"/api-reference/all-endpoints/voice/cancel-warm-transfer"},{"title":"List sip-trunks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks","href":"/api-reference/all-endpoints/voice/list-sip-trunks"},{"title":"Create an outbound SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks","href":"/api-reference/all-endpoints/voice/create-an-outbound-sip-trunk"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/health","href":"/api-reference/all-endpoints/voice/list-health"},{"title":"List route-quality","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/route-quality","href":"/api-reference/all-endpoints/voice/list-route-quality"},{"title":"List terminations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/terminations","href":"/api-reference/all-endpoints/voice/list-terminations"},{"title":"Get sip-trunks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}","href":"/api-reference/all-endpoints/voice/get-sip-trunks"},{"title":"Update sip-trunks","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/sip-trunks/{id}","href":"/api-reference/all-endpoints/voice/update-sip-trunks"},{"title":"Delete sip-trunks","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/sip-trunks/{id}","href":"/api-reference/all-endpoints/voice/delete-sip-trunks"},{"title":"Create an inbound SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/incoming","href":"/api-reference/all-endpoints/voice/create-an-inbound-sip-trunk"},{"title":"BYOC trunk onboarding readiness check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/{id}/onboarding/verify","href":"/api-reference/all-endpoints/voice/byoc-trunk-onboarding-readiness-check"},{"title":"Reset BYOC trunk onboarding","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/{id}/onboarding/reset","href":"/api-reference/all-endpoints/voice/reset-byoc-trunk-onboarding"},{"title":"Rotate inbound trunk digest credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/{id}/credentials/rotate","href":"/api-reference/all-endpoints/voice/rotate-inbound-trunk-digest-credentials"},{"title":"List reveal","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}/credentials/reveal","href":"/api-reference/all-endpoints/voice/list-reveal"},{"title":"List usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}/usage","href":"/api-reference/all-endpoints/voice/list-usage"},{"title":"List utilization","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}/utilization","href":"/api-reference/all-endpoints/voice/list-utilization"},{"title":"List routing-analysis","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}/routing-analysis","href":"/api-reference/all-endpoints/voice/list-routing-analysis"},{"title":"Probe an outbound SIP trunk pre-save","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/probe","href":"/api-reference/all-endpoints/voice/probe-an-outbound-sip-trunk-pre-save"},{"title":"Test an existing SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/{id}/test","href":"/api-reference/all-endpoints/voice/test-an-existing-sip-trunk"},{"title":"Place a test call through an outbound trunk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/sip-trunks/{id}/test-call","href":"/api-reference/all-endpoints/voice/place-a-test-call-through-an-outbound-trunk"},{"title":"List rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/{id}/rate","href":"/api-reference/all-endpoints/voice/list-rate"},{"title":"List auth-failures","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sip-trunks/incoming/{id}/auth-failures","href":"/api-reference/all-endpoints/voice/list-auth-failures"},{"title":"Verify caller-ids","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/caller-ids/verify","href":"/api-reference/all-endpoints/voice/verify-caller-ids"},{"title":"Confirm caller-ids","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/caller-ids/confirm","href":"/api-reference/all-endpoints/voice/confirm-caller-ids"},{"title":"Create resend","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/caller-ids/{id}/resend","href":"/api-reference/all-endpoints/voice/create-resend"},{"title":"List caller-ids","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/caller-ids","href":"/api-reference/all-endpoints/voice/list-caller-ids"},{"title":"Delete caller-ids","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/caller-ids/{id}","href":"/api-reference/all-endpoints/voice/delete-caller-ids"},{"title":"List ivr-flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows","href":"/api-reference/all-endpoints/voice/list-ivr-flows"},{"title":"Ivr-flows voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-flows","href":"/api-reference/all-endpoints/voice/ivr-flows-voice"},{"title":"Get ivr-flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows/{id}","href":"/api-reference/all-endpoints/voice/get-ivr-flows-1"},{"title":"Update ivr-flows","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/ivr-flows/{id}","href":"/api-reference/all-endpoints/voice/update-ivr-flows"},{"title":"Delete ivr-flows","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/ivr-flows/{id}","href":"/api-reference/all-endpoints/voice/delete-ivr-flows"},{"title":"Create publish","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-flows/{id}/publish","href":"/api-reference/all-endpoints/voice/create-publish"},{"title":"List versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows/{id}/versions","href":"/api-reference/all-endpoints/voice/list-versions"},{"title":"List compare","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows/{id}/versions/{version}/compare","href":"/api-reference/all-endpoints/voice/list-compare"},{"title":"Create revert","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-flows/{id}/versions/{version}/revert","href":"/api-reference/all-endpoints/voice/create-revert"},{"title":"List node-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows/{id}/node-analytics","href":"/api-reference/all-endpoints/voice/list-node-analytics"},{"title":"List ab-results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-flows/{id}/ab-results","href":"/api-reference/all-endpoints/voice/list-ab-results"},{"title":"Create simulate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-flows/{id}/simulate","href":"/api-reference/all-endpoints/voice/create-simulate"},{"title":"List conferences","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences","href":"/api-reference/all-endpoints/voice/list-conferences"},{"title":"Conferences voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences","href":"/api-reference/all-endpoints/voice/conferences-voice"},{"title":"List aggregate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/aggregate","href":"/api-reference/all-endpoints/voice/list-aggregate-1"},{"title":"List failure-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/failure-analytics","href":"/api-reference/all-endpoints/voice/list-failure-analytics"},{"title":"Get conferences","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/{id}","href":"/api-reference/all-endpoints/voice/get-conferences"},{"title":"Delete conferences","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/conferences/{id}","href":"/api-reference/all-endpoints/voice/delete-conferences"},{"title":"Patch conferences","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/conferences/{id}","href":"/api-reference/all-endpoints/voice/patch-conferences"},{"title":"List participants","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/{id}/participants","href":"/api-reference/all-endpoints/voice/list-participants"},{"title":"Create participants","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants","href":"/api-reference/all-endpoints/voice/create-participants"},{"title":"Create end","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/end","href":"/api-reference/all-endpoints/voice/create-end"},{"title":"Create consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants/{participantId}/consent","href":"/api-reference/all-endpoints/voice/create-consent"},{"title":"Create regenerate-pin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/regenerate-pin","href":"/api-reference/all-endpoints/voice/create-regenerate-pin"},{"title":"Create ai-agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/ai-agent","href":"/api-reference/all-endpoints/voice/create-ai-agent"},{"title":"Delete ai-agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/conferences/{id}/ai-agent","href":"/api-reference/all-endpoints/voice/delete-ai-agent"},{"title":"List ai-handoff","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/ai-handoff","href":"/api-reference/all-endpoints/voice/list-ai-handoff"},{"title":"Create ai-handoff","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/ai-handoff","href":"/api-reference/all-endpoints/voice/create-ai-handoff"},{"title":"Whisper ai-agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/ai-agent/whisper","href":"/api-reference/all-endpoints/voice/whisper-ai-agent"},{"title":"List ai-agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/{id}/ai-agents","href":"/api-reference/all-endpoints/voice/list-ai-agents"},{"title":"Delete participants","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/conferences/{id}/participants/{participantId}","href":"/api-reference/all-endpoints/voice/delete-participants"},{"title":"Create mute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants/{participantId}/mute","href":"/api-reference/all-endpoints/voice/create-mute-1"},{"title":"Create unmute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants/{participantId}/unmute","href":"/api-reference/all-endpoints/voice/create-unmute-1"},{"title":"Create mute-all","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/mute-all","href":"/api-reference/all-endpoints/voice/create-mute-all"},{"title":"Create unmute-all","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/unmute-all","href":"/api-reference/all-endpoints/voice/create-unmute-all"},{"title":"Create lock","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/lock","href":"/api-reference/all-endpoints/voice/create-lock"},{"title":"Create unlock","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/unlock","href":"/api-reference/all-endpoints/voice/create-unlock"},{"title":"Create hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants/{participantId}/hold","href":"/api-reference/all-endpoints/voice/create-hold-1"},{"title":"Create unhold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/participants/{participantId}/unhold","href":"/api-reference/all-endpoints/voice/create-unhold-1"},{"title":"Consent-collection recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/recording/consent-collection","href":"/api-reference/all-endpoints/voice/consent-collection-recording"},{"title":"Start recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/recording/start","href":"/api-reference/all-endpoints/voice/start-recording-1"},{"title":"Stop recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/conferences/{id}/recording/stop","href":"/api-reference/all-endpoints/voice/stop-recording-1"},{"title":"List recording","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/conferences/{id}/recording","href":"/api-reference/all-endpoints/voice/list-recording"},{"title":"Delete recording","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/conferences/{id}/recording","href":"/api-reference/all-endpoints/voice/delete-recording"},{"title":"List recording","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/recording","href":"/api-reference/all-endpoints/voice/list-recording-1"},{"title":"Transcribe voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/transcribe","href":"/api-reference/all-endpoints/voice/transcribe-voice"},{"title":"List transcript","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/transcript","href":"/api-reference/all-endpoints/voice/list-transcript"},{"title":"Create sentiment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/sentiment","href":"/api-reference/all-endpoints/voice/create-sentiment"},{"title":"Correct-entities transcript","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/transcript/correct-entities","href":"/api-reference/all-endpoints/voice/correct-entities-transcript"},{"title":"List voicemails","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemails","href":"/api-reference/all-endpoints/voice/list-voicemails"},{"title":"List search","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemails/search","href":"/api-reference/all-endpoints/voice/list-search-1"},{"title":"Get voicemails","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemails/{id}","href":"/api-reference/all-endpoints/voice/get-voicemails"},{"title":"Delete voicemails","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/voicemails/{id}","href":"/api-reference/all-endpoints/voice/delete-voicemails"},{"title":"Patch read","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/voicemails/{id}/read","href":"/api-reference/all-endpoints/voice/patch-read"},{"title":"List team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemails/team","href":"/api-reference/all-endpoints/voice/list-team"},{"title":"Create claim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemails/{id}/claim","href":"/api-reference/all-endpoints/voice/create-claim"},{"title":"Create team-read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemails/{id}/team-read","href":"/api-reference/all-endpoints/voice/create-team-read"},{"title":"Create forward","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemails/{id}/forward","href":"/api-reference/all-endpoints/voice/create-forward"},{"title":"List queues","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues","href":"/api-reference/all-endpoints/voice/list-queues"},{"title":"Queues voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues","href":"/api-reference/all-endpoints/voice/queues-voice"},{"title":"Available agent count","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/available-agents","href":"/api-reference/all-endpoints/voice/available-agent-count"},{"title":"Update queues","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/queues/{id}","href":"/api-reference/all-endpoints/voice/update-queues"},{"title":"Delete queues","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}","href":"/api-reference/all-endpoints/voice/delete-queues"},{"title":"Enqueue an inbound call for ACD dispatch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/enqueue","href":"/api-reference/all-endpoints/voice/enqueue-an-inbound-call-for-acd-dispatch"},{"title":"Move a waiting call to the head of the queue","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/calls/{callId}/bump","href":"/api-reference/all-endpoints/voice/move-a-waiting-call-to-the-head-of-the-queue"},{"title":"List stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/stats","href":"/api-reference/all-endpoints/voice/list-stats"},{"title":"Arm or disarm a queue's emergency route override","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/emergency","href":"/api-reference/all-endpoints/voice/arm-or-disarm-a-queues-emergency-route-override"},{"title":"List state-reasons","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents/state-reasons","href":"/api-reference/all-endpoints/voice/list-state-reasons"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents","href":"/api-reference/all-endpoints/voice/list-agents"},{"title":"List pause-reason-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents/pause-reason-codes","href":"/api-reference/all-endpoints/voice/list-pause-reason-codes"},{"title":"Create a tenant away-state (pause) reason code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/pause-reason-codes","href":"/api-reference/all-endpoints/voice/create-a-tenant-away-state-pause-reason-code"},{"title":"Delete pause-reason-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/agents/pause-reason-codes/{id}","href":"/api-reference/all-endpoints/voice/delete-pause-reason-codes"},{"title":"Patch pause-reason-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/agents/pause-reason-codes/{id}","href":"/api-reference/all-endpoints/voice/patch-pause-reason-codes"},{"title":"List hold-reason-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/hold-reason-codes","href":"/api-reference/all-endpoints/voice/list-hold-reason-codes"},{"title":"List recording-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/recording-policy","href":"/api-reference/all-endpoints/voice/list-recording-policy"},{"title":"Update recording-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/recording-policy","href":"/api-reference/all-endpoints/voice/update-recording-policy"},{"title":"List dub","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/recording/dub","href":"/api-reference/all-endpoints/voice/list-dub"},{"title":"Dub recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/dub","href":"/api-reference/all-endpoints/voice/dub-recording"},{"title":"Isolate recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/isolate","href":"/api-reference/all-endpoints/voice/isolate-recording"},{"title":"Align recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/recording/align","href":"/api-reference/all-endpoints/voice/align-recording"},{"title":"Create status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/{id}/status","href":"/api-reference/all-endpoints/voice/create-status"},{"title":"Create register","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/{id}/register","href":"/api-reference/all-endpoints/voice/create-register"},{"title":"Create heartbeat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/{id}/heartbeat","href":"/api-reference/all-endpoints/voice/create-heartbeat"},{"title":"Distress me","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/me/distress","href":"/api-reference/all-endpoints/voice/distress-me"},{"title":"Update skills","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/agents/{id}/skills","href":"/api-reference/all-endpoints/voice/update-skills"},{"title":"Patch skills","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/agents/{id}/skills","href":"/api-reference/all-endpoints/voice/patch-skills"},{"title":"List skill-proficiency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents/{id}/skill-proficiency","href":"/api-reference/all-endpoints/voice/list-skill-proficiency"},{"title":"Patch skill-proficiency","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/agents/{id}/skill-proficiency","href":"/api-reference/all-endpoints/voice/patch-skill-proficiency"},{"title":"List queue-weights","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents/{id}/queue-weights","href":"/api-reference/all-endpoints/voice/list-queue-weights"},{"title":"Update an agent's per-queue routing weights","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/agents/{id}/queue-weights","href":"/api-reference/all-endpoints/voice/update-an-agents-per-queue-routing-weights"},{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/members","href":"/api-reference/all-endpoints/voice/list-members"},{"title":"Assign an agent to a queue","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/members","href":"/api-reference/all-endpoints/voice/assign-an-agent-to-a-queue"},{"title":"Delete members","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/members/{memberId}","href":"/api-reference/all-endpoints/voice/delete-members"},{"title":"Patch members","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{id}/members/{memberId}","href":"/api-reference/all-endpoints/voice/patch-members"},{"title":"List a queue's wrap-up disposition (reason code) catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{queueId}/dispositions","href":"/api-reference/all-endpoints/voice/list-a-queues-wrap-up-disposition-reason-code-catalog"},{"title":"Create a queue disposition (wrap-up code) catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{queueId}/dispositions","href":"/api-reference/all-endpoints/voice/create-a-queue-disposition-wrap-up-code-catalog-row"},{"title":"Retire a queue disposition (wrap-up code) catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{queueId}/dispositions/{id}","href":"/api-reference/all-endpoints/voice/retire-a-queue-disposition-wrap-up-code-catalog-row"},{"title":"Update a queue disposition (wrap-up code) catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{queueId}/dispositions/{id}","href":"/api-reference/all-endpoints/voice/update-a-queue-disposition-wrap-up-code-catalog-row"},{"title":"Create disposition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{queueId}/calls/{callId}/disposition","href":"/api-reference/all-endpoints/voice/create-disposition"},{"title":"List suggestion","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{queueId}/calls/{callId}/disposition/suggestion","href":"/api-reference/all-endpoints/voice/list-suggestion"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dispositions/analytics","href":"/api-reference/all-endpoints/voice/list-analytics"},{"title":"List aux-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/aux-codes","href":"/api-reference/all-endpoints/voice/list-aux-codes"},{"title":"Aux-codes voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/aux-codes","href":"/api-reference/all-endpoints/voice/aux-codes-voice"},{"title":"Delete aux-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/aux-codes/{id}","href":"/api-reference/all-endpoints/voice/delete-aux-codes"},{"title":"Patch aux-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/aux-codes/{id}","href":"/api-reference/all-endpoints/voice/patch-aux-codes"},{"title":"List disposition-tags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/disposition-tags","href":"/api-reference/all-endpoints/voice/list-disposition-tags"},{"title":"Disposition-tags voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/disposition-tags","href":"/api-reference/all-endpoints/voice/disposition-tags-voice"},{"title":"Delete disposition-tags","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/disposition-tags/{id}","href":"/api-reference/all-endpoints/voice/delete-disposition-tags"},{"title":"Patch disposition-tags","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/disposition-tags/{id}","href":"/api-reference/all-endpoints/voice/patch-disposition-tags"},{"title":"List disposition-tags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/disposition-tags","href":"/api-reference/all-endpoints/voice/list-disposition-tags-1"},{"title":"Create disposition-tags","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/disposition-tags","href":"/api-reference/all-endpoints/voice/create-disposition-tags"},{"title":"Read a call's account-code annotation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/account-code","href":"/api-reference/all-endpoints/voice/read-a-calls-account-code-annotation"},{"title":"Set or replace a call's account / cost-center / matter code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/account-code","href":"/api-reference/all-endpoints/voice/set-or-replace-a-calls-account-cost-center-matter-code"},{"title":"Clear a call's account-code annotation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/calls/{callId}/account-code","href":"/api-reference/all-endpoints/voice/clear-a-calls-account-code-annotation"},{"title":"Read a call's KBA verified-session status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{callId}/kba-verification","href":"/api-reference/all-endpoints/voice/read-a-calls-kba-verified-session-status"},{"title":"Submit a knowledge-based-authentication (KBA) check pass for a call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{callId}/kba-verification","href":"/api-reference/all-endpoints/voice/submit-a-knowledge-based-authentication-kba-check-pass-for-a-call"},{"title":"Reset a call's KBA verified session","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/calls/{callId}/kba-verification","href":"/api-reference/all-endpoints/voice/reset-a-calls-kba-verified-session"},{"title":"List entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/entries","href":"/api-reference/all-endpoints/voice/list-entries"},{"title":"Patch entries","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{id}/entries/{entryId}","href":"/api-reference/all-endpoints/voice/patch-entries"},{"title":"List tenant skill catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/skill-catalog","href":"/api-reference/all-endpoints/voice/list-tenant-skill-catalog"},{"title":"Create a tenant skill catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/skill-catalog","href":"/api-reference/all-endpoints/voice/create-a-tenant-skill-catalog-row"},{"title":"Soft-delete a tenant skill catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/skill-catalog/{id}","href":"/api-reference/all-endpoints/voice/soft-delete-a-tenant-skill-catalog-row"},{"title":"Update a tenant skill catalog row","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/skill-catalog/{id}","href":"/api-reference/all-endpoints/voice/update-a-tenant-skill-catalog-row"},{"title":"List the stock voice-prompt library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/stock-prompts","href":"/api-reference/all-endpoints/voice/list-the-stock-voice-prompt-library"},{"title":"Get one stock voice prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/stock-prompts/{id}","href":"/api-reference/all-endpoints/voice/get-one-stock-voice-prompt"},{"title":"Synthesize (or replay cached) audio for a stock voice prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/stock-prompts/{id}/synthesize","href":"/api-reference/all-endpoints/voice/synthesize-or-replay-cached-audio-for-a-stock-voice-prompt"},{"title":"List the stock voice library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/stock-voices","href":"/api-reference/all-endpoints/voice/list-the-stock-voice-library"},{"title":"Get one stock voice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/stock-voices/{id}","href":"/api-reference/all-endpoints/voice/get-one-stock-voice"},{"title":"List a queue's time-of-day schedule routes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/schedule-routes","href":"/api-reference/all-endpoints/voice/list-a-queues-time-of-day-schedule-routes"},{"title":"Create a time-of-day schedule route","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/schedule-routes","href":"/api-reference/all-endpoints/voice/create-a-time-of-day-schedule-route"},{"title":"Soft-delete a time-of-day schedule route","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/schedule-routes/{routeId}","href":"/api-reference/all-endpoints/voice/soft-delete-a-time-of-day-schedule-route"},{"title":"Update a time-of-day schedule route","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{id}/schedule-routes/{routeId}","href":"/api-reference/all-endpoints/voice/update-a-time-of-day-schedule-route"},{"title":"List agent skill certifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/skill-certifications","href":"/api-reference/all-endpoints/voice/list-agent-skill-certifications"},{"title":"Set or renew an agent skill certification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/skill-certifications","href":"/api-reference/all-endpoints/voice/set-or-renew-an-agent-skill-certification"},{"title":"Revoke an agent skill certification","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/skill-certifications/{id}","href":"/api-reference/all-endpoints/voice/revoke-an-agent-skill-certification"},{"title":"Amend an existing skill certification","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/skill-certifications/{id}","href":"/api-reference/all-endpoints/voice/amend-an-existing-skill-certification"},{"title":"List state-history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agents/{id}/state-history","href":"/api-reference/all-endpoints/voice/list-state-history"},{"title":"Extend the caller's current wrap-up (after-call work) window","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agents/me/extend-wrapup","href":"/api-reference/all-endpoints/voice/extend-the-callers-current-wrap-up-after-call-work-window"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/analytics","href":"/api-reference/all-endpoints/voice/list-analytics-1"},{"title":"List heatmap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/heatmap","href":"/api-reference/all-endpoints/voice/list-heatmap"},{"title":"List agent-leaderboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/agent-leaderboard","href":"/api-reference/all-endpoints/voice/list-agent-leaderboard"},{"title":"List comparison","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/comparison","href":"/api-reference/all-endpoints/voice/list-comparison"},{"title":"List hangup-breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/hangup-breakdown","href":"/api-reference/all-endpoints/voice/list-hangup-breakdown"},{"title":"List skill-breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/skill-breakdown","href":"/api-reference/all-endpoints/voice/list-skill-breakdown"},{"title":"List live","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/live","href":"/api-reference/all-endpoints/voice/list-live"},{"title":"List per-queue supervisor alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/alert-rules","href":"/api-reference/all-endpoints/voice/list-per-queue-supervisor-alert-rules"},{"title":"Create a per-queue alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/alert-rules","href":"/api-reference/all-endpoints/voice/create-a-per-queue-alert-rule"},{"title":"Delete a per-queue alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/alert-rules/{ruleId}","href":"/api-reference/all-endpoints/voice/delete-a-per-queue-alert-rule"},{"title":"Update a per-queue alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{id}/alert-rules/{ruleId}","href":"/api-reference/all-endpoints/voice/update-a-per-queue-alert-rule"},{"title":"List wallboard alarm rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/wallboard/alarm-rules","href":"/api-reference/all-endpoints/voice/list-wallboard-alarm-rules"},{"title":"Create a wallboard alarm rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/wallboard/alarm-rules","href":"/api-reference/all-endpoints/voice/create-a-wallboard-alarm-rule"},{"title":"Delete a wallboard alarm rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/wallboard/alarm-rules/{ruleId}","href":"/api-reference/all-endpoints/voice/delete-a-wallboard-alarm-rule"},{"title":"Update a wallboard alarm rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/wallboard/alarm-rules/{ruleId}","href":"/api-reference/all-endpoints/voice/update-a-wallboard-alarm-rule"},{"title":"List sla-hub","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/sla-hub","href":"/api-reference/all-endpoints/voice/list-sla-hub"},{"title":"List callback-sla","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/callback-sla","href":"/api-reference/all-endpoints/voice/list-callback-sla"},{"title":"List policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/callback-sla/policy","href":"/api-reference/all-endpoints/voice/list-policy"},{"title":"Update policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/queues/{id}/callback-sla/policy","href":"/api-reference/all-endpoints/voice/update-policy"},{"title":"Delete policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/callback-sla/policy","href":"/api-reference/all-endpoints/voice/delete-policy"},{"title":"Breach-scan callback-sla","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/callback-sla/breach-scan","href":"/api-reference/all-endpoints/voice/breach-scan-callback-sla"},{"title":"List policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/sla-breach/policy","href":"/api-reference/all-endpoints/voice/list-policy-1"},{"title":"Update policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/queues/{id}/sla-breach/policy","href":"/api-reference/all-endpoints/voice/update-policy-1"},{"title":"Delete policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/sla-breach/policy","href":"/api-reference/all-endpoints/voice/delete-policy-1"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/sla-breach/events","href":"/api-reference/all-endpoints/voice/list-events"},{"title":"Submit a queue SLA window sample for breach evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/sla-breach/scan","href":"/api-reference/all-endpoints/voice/submit-a-queue-sla-window-sample-for-breach-evaluation"},{"title":"Create sla-forecast","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/sla-forecast","href":"/api-reference/all-endpoints/voice/create-sla-forecast"},{"title":"List agent-guided call scripts for a queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/scripts","href":"/api-reference/all-endpoints/voice/list-agent-guided-call-scripts-for-a-queue"},{"title":"Create a queue script","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{id}/scripts","href":"/api-reference/all-endpoints/voice/create-a-queue-script"},{"title":"Get one queue script with its sections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{id}/scripts/{scriptId}","href":"/api-reference/all-endpoints/voice/get-one-queue-script-with-its-sections"},{"title":"Delete a queue script","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/queues/{id}/scripts/{scriptId}","href":"/api-reference/all-endpoints/voice/delete-a-queue-script"},{"title":"Update queue script metadata and sections","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{id}/scripts/{scriptId}","href":"/api-reference/all-endpoints/voice/update-queue-script-metadata-and-sections"},{"title":"List blf","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/blf","href":"/api-reference/all-endpoints/voice/list-blf"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/blf/stream","href":"/api-reference/all-endpoints/voice/list-stream-5"},{"title":"List mwi","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/mwi","href":"/api-reference/all-endpoints/voice/list-mwi"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/mwi/stream","href":"/api-reference/all-endpoints/voice/list-stream-6"},{"title":"Create listen","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/listen","href":"/api-reference/all-endpoints/voice/create-listen"},{"title":"Create whisper","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/whisper","href":"/api-reference/all-endpoints/voice/create-whisper"},{"title":"Create barge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/barge","href":"/api-reference/all-endpoints/voice/create-barge"},{"title":"Create conference-join","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/conference-join","href":"/api-reference/all-endpoints/voice/create-conference-join"},{"title":"Create unlisten","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/unlisten","href":"/api-reference/all-endpoints/voice/create-unlisten"},{"title":"List capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/capabilities","href":"/api-reference/all-endpoints/voice/list-capabilities-1"},{"title":"Create whisper-text","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/calls/{id}/whisper-text","href":"/api-reference/all-endpoints/voice/create-whisper-text"},{"title":"Create monitor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/calls/{id}/monitor","href":"/api-reference/all-endpoints/voice/create-monitor"},{"title":"Team-monitor supervisor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/team-monitor","href":"/api-reference/all-endpoints/voice/team-monitor-supervisor"},{"title":"List monitor-sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/monitor-sessions","href":"/api-reference/all-endpoints/voice/list-monitor-sessions"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/calls/{callId}/transcript/stream","href":"/api-reference/all-endpoints/voice/list-stream-7"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/calls/{callId}/analytics/stream","href":"/api-reference/all-endpoints/voice/list-stream-8"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/calls/{callId}/assist/stream","href":"/api-reference/all-endpoints/voice/list-stream-9"},{"title":"Create ai-pause","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/ai-pause","href":"/api-reference/all-endpoints/voice/create-ai-pause"},{"title":"Create handback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/handback","href":"/api-reference/all-endpoints/voice/create-handback"},{"title":"Create ai-resume","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/ai-resume","href":"/api-reference/all-endpoints/voice/create-ai-resume"},{"title":"List monitoring","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/monitoring","href":"/api-reference/all-endpoints/voice/list-monitoring"},{"title":"List coaching-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/coaching-templates","href":"/api-reference/all-endpoints/voice/list-coaching-templates"},{"title":"Coaching-templates supervisor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/coaching-templates","href":"/api-reference/all-endpoints/voice/coaching-templates-supervisor"},{"title":"Delete coaching-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/supervisor/coaching-templates/{id}","href":"/api-reference/all-endpoints/voice/delete-coaching-templates"},{"title":"Patch coaching-templates","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/supervisor/coaching-templates/{id}","href":"/api-reference/all-endpoints/voice/patch-coaching-templates"},{"title":"List agent-leaderboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/agent-leaderboard","href":"/api-reference/all-endpoints/voice/list-agent-leaderboard-1"},{"title":"List gamification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/gamification","href":"/api-reference/all-endpoints/voice/list-gamification"},{"title":"List omnichannel-capacity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/omnichannel-capacity","href":"/api-reference/all-endpoints/voice/list-omnichannel-capacity"},{"title":"List omnichannel-wallboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/omnichannel-wallboard","href":"/api-reference/all-endpoints/voice/list-omnichannel-wallboard"},{"title":"List wallboard-hub","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/wallboard-hub","href":"/api-reference/all-endpoints/voice/list-wallboard-hub"},{"title":"List ops-overview","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/ops-overview","href":"/api-reference/all-endpoints/voice/list-ops-overview"},{"title":"List omnichannel-queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/omnichannel-queue","href":"/api-reference/all-endpoints/voice/list-omnichannel-queue"},{"title":"Reserve omnichannel-capacity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/omnichannel-capacity/reserve","href":"/api-reference/all-endpoints/voice/reserve-omnichannel-capacity"},{"title":"Release omnichannel-capacity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/omnichannel-capacity/release","href":"/api-reference/all-endpoints/voice/release-omnichannel-capacity"},{"title":"List slots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/omnichannel-capacity/agents/{agentUserId}/slots","href":"/api-reference/all-endpoints/voice/list-slots"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/capacity/events","href":"/api-reference/all-endpoints/voice/list-events-1"},{"title":"Create raise-hand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/raise-hand","href":"/api-reference/all-endpoints/voice/create-raise-hand"},{"title":"List hand-raises","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/hand-raises","href":"/api-reference/all-endpoints/voice/list-hand-raises"},{"title":"Create resolve","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/hand-raises/{id}/resolve","href":"/api-reference/all-endpoints/voice/create-resolve"},{"title":"List agent-grid","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/agent-grid","href":"/api-reference/all-endpoints/voice/list-agent-grid"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/agent-grid/events","href":"/api-reference/all-endpoints/voice/list-events-2"},{"title":"Create force-state","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/agents/{id}/force-state","href":"/api-reference/all-endpoints/voice/create-force-state"},{"title":"Mint a short-lived announce SSE ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/announce/ticket","href":"/api-reference/all-endpoints/voice/mint-a-short-lived-announce-sse-ticket"},{"title":"Announce supervisor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/announce","href":"/api-reference/all-endpoints/voice/announce-supervisor"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/announce/stream","href":"/api-reference/all-endpoints/voice/list-stream-10"},{"title":"List takeovers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/takeovers","href":"/api-reference/all-endpoints/voice/list-takeovers"},{"title":"Takeovers supervisor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/takeovers","href":"/api-reference/all-endpoints/voice/takeovers-supervisor"},{"title":"Get takeovers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/supervisor/takeovers/{id}","href":"/api-reference/all-endpoints/voice/get-takeovers"},{"title":"Patch takeovers","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/supervisor/takeovers/{id}","href":"/api-reference/all-endpoints/voice/patch-takeovers"},{"title":"Callbacks supervisor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/supervisor/callbacks","href":"/api-reference/all-endpoints/voice/callbacks-supervisor"},{"title":"List regions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/regions","href":"/api-reference/all-endpoints/voice/list-regions"},{"title":"List preferred","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/regions/preferred","href":"/api-reference/all-endpoints/voice/list-preferred"},{"title":"Update preferred","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/regions/preferred","href":"/api-reference/all-endpoints/voice/update-preferred"},{"title":"List country-coverage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/country-coverage","href":"/api-reference/all-endpoints/voice/list-country-coverage"},{"title":"List callbacks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/callbacks","href":"/api-reference/all-endpoints/voice/list-callbacks"},{"title":"Delete callbacks","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/callbacks/{id}","href":"/api-reference/all-endpoints/voice/delete-callbacks"},{"title":"Patch callbacks","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/callbacks/{id}","href":"/api-reference/all-endpoints/voice/patch-callbacks"},{"title":"List disposition-callback-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{queueId}/disposition-callback-rules","href":"/api-reference/all-endpoints/voice/list-disposition-callback-rules"},{"title":"Create disposition-callback-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{queueId}/disposition-callback-rules","href":"/api-reference/all-endpoints/voice/create-disposition-callback-rules"},{"title":"Patch disposition-callback-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/queues/{queueId}/disposition-callback-rules/{id}","href":"/api-reference/all-endpoints/voice/patch-disposition-callback-rules"},{"title":"Create squad-route","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/squad-route","href":"/api-reference/all-endpoints/voice/create-squad-route"},{"title":"List availability","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/queues/{queueId}/availability","href":"/api-reference/all-endpoints/voice/list-availability"},{"title":"Create appointments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/queues/{queueId}/appointments","href":"/api-reference/all-endpoints/voice/create-appointments"},{"title":"List callback-in-queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/callback-in-queue","href":"/api-reference/all-endpoints/voice/list-callback-in-queue"},{"title":"Delete callback-in-queue","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/callback-in-queue/{id}","href":"/api-reference/all-endpoints/voice/delete-callback-in-queue"},{"title":"List ivr-intents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-intents","href":"/api-reference/all-endpoints/voice/list-ivr-intents"},{"title":"Ivr-intents voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-intents","href":"/api-reference/all-endpoints/voice/ivr-intents-voice"},{"title":"Delete ivr-intents","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/ivr-intents/{id}","href":"/api-reference/all-endpoints/voice/delete-ivr-intents"},{"title":"Patch ivr-intents","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/ivr-intents/{id}","href":"/api-reference/all-endpoints/voice/patch-ivr-intents"},{"title":"Test ivr-intents","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-intents/test","href":"/api-reference/all-endpoints/voice/test-ivr-intents"},{"title":"Extract ivr-slots","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-slots/extract","href":"/api-reference/all-endpoints/voice/extract-ivr-slots"},{"title":"List ivr-nlu-hints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ivr-nlu-hints","href":"/api-reference/all-endpoints/voice/list-ivr-nlu-hints"},{"title":"Ivr-nlu-hints voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-nlu-hints","href":"/api-reference/all-endpoints/voice/ivr-nlu-hints-voice"},{"title":"Delete ivr-nlu-hints","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/ivr-nlu-hints/{id}","href":"/api-reference/all-endpoints/voice/delete-ivr-nlu-hints"},{"title":"Patch ivr-nlu-hints","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/ivr-nlu-hints/{id}","href":"/api-reference/all-endpoints/voice/patch-ivr-nlu-hints"},{"title":"Build-hints ivr-nlu-hints","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ivr-nlu-hints/build-hints","href":"/api-reference/all-endpoints/voice/build-hints-ivr-nlu-hints"},{"title":"Challenge kba","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/kba/challenge","href":"/api-reference/all-endpoints/voice/challenge-kba"},{"title":"Verify kba","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/kba/verify","href":"/api-reference/all-endpoints/voice/verify-kba"},{"title":"Check session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/kba/session/check","href":"/api-reference/all-endpoints/voice/check-session"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/csat/surveys/{id}/analytics","href":"/api-reference/all-endpoints/voice/list-analytics-2"},{"title":"List config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/csat/surveys/{id}/config","href":"/api-reference/all-endpoints/voice/list-config-2"},{"title":"Patch config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/csat/surveys/{id}/config","href":"/api-reference/all-endpoints/voice/patch-config-2"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/nps/surveys/{id}/analytics","href":"/api-reference/all-endpoints/voice/list-analytics-3"},{"title":"List config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/nps/surveys/{id}/config","href":"/api-reference/all-endpoints/voice/list-config-3"},{"title":"Patch config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/nps/surveys/{id}/config","href":"/api-reference/all-endpoints/voice/patch-config-3"},{"title":"List greeting","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemail/greeting","href":"/api-reference/all-endpoints/voice/list-greeting"},{"title":"Greeting voicemail","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemail/greeting","href":"/api-reference/all-endpoints/voice/greeting-voicemail"},{"title":"Delete greeting","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/voicemail/greeting","href":"/api-reference/all-endpoints/voice/delete-greeting"},{"title":"Tts greeting","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemail/greeting/tts","href":"/api-reference/all-endpoints/voice/tts-greeting"},{"title":"Hot-desk sign-in","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/hot-desking/sign-in","href":"/api-reference/all-endpoints/voice/hot-desk-sign-in"},{"title":"Hot-desk sign-out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/hot-desking/sign-out","href":"/api-reference/all-endpoints/voice/hot-desk-sign-out"},{"title":"Admin force-release a hot-desk session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/hot-desking/{id}/revoke","href":"/api-reference/all-endpoints/voice/admin-force-release-a-hot-desk-session"},{"title":"List active hot-desk sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/hot-desking","href":"/api-reference/all-endpoints/voice/list-active-hot-desk-sessions"},{"title":"Get the caller's active hot-desk session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/hot-desking/me","href":"/api-reference/all-endpoints/voice/get-the-callers-active-hot-desk-session"},{"title":"List desk reservations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/hoteling/reservations","href":"/api-reference/all-endpoints/voice/list-desk-reservations"},{"title":"Book an advance desk reservation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/hoteling/reservations","href":"/api-reference/all-endpoints/voice/book-an-advance-desk-reservation"},{"title":"Cancel a desk reservation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/hoteling/reservations/{id}","href":"/api-reference/all-endpoints/voice/cancel-a-desk-reservation"},{"title":"Release elapsed / no-show reservations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/hoteling/reservations/sweep","href":"/api-reference/all-endpoints/voice/release-elapsed-no-show-reservations"},{"title":"Emergency-location voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/emergency-location","href":"/api-reference/all-endpoints/voice/emergency-location-voice"},{"title":"Get emergency-location","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/emergency-location/{numberId}","href":"/api-reference/all-endpoints/voice/get-emergency-location"},{"title":"List resolve","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/emergency-location/{numberId}/resolve","href":"/api-reference/all-endpoints/voice/list-resolve"},{"title":"Delete devices","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/emergency-location/{numberId}/devices/{deviceKey}","href":"/api-reference/all-endpoints/voice/delete-devices"},{"title":"Psap-callback voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/psap-callback","href":"/api-reference/all-endpoints/voice/psap-callback-voice"},{"title":"Get psap-callback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/psap-callback/{numberId}","href":"/api-reference/all-endpoints/voice/get-psap-callback"},{"title":"Delete psap-callback","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/psap-callback/{numberId}","href":"/api-reference/all-endpoints/voice/delete-psap-callback"},{"title":"List resolve","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/psap-callback/{numberId}/resolve","href":"/api-reference/all-endpoints/voice/list-resolve-1"},{"title":"Get my call-forwarding rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/call-forwarding","href":"/api-reference/all-endpoints/voice/get-my-call-forwarding-rule"},{"title":"Upsert my call-forwarding rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/call-forwarding","href":"/api-reference/all-endpoints/voice/upsert-my-call-forwarding-rule"},{"title":"Clear my call-forwarding rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/call-forwarding","href":"/api-reference/all-endpoints/voice/clear-my-call-forwarding-rule"},{"title":"List org call-forwarding rules (admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/call-forwarding/users","href":"/api-reference/all-endpoints/voice/list-org-call-forwarding-rules-admin"},{"title":"Get a user's call-forwarding rule (admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/call-forwarding/users/{userId}","href":"/api-reference/all-endpoints/voice/get-a-users-call-forwarding-rule-admin"},{"title":"Upsert a user's call-forwarding rule (admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/call-forwarding/users/{userId}","href":"/api-reference/all-endpoints/voice/upsert-a-users-call-forwarding-rule-admin"},{"title":"Clear a user's call-forwarding rule (admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/call-forwarding/users/{userId}","href":"/api-reference/all-endpoints/voice/clear-a-users-call-forwarding-rule-admin"},{"title":"List DNIS inbound-routing rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dnis-routes","href":"/api-reference/all-endpoints/voice/list-dnis-inbound-routing-rules"},{"title":"Create a DNIS inbound-routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/dnis-routes","href":"/api-reference/all-endpoints/voice/create-a-dnis-inbound-routing-rule"},{"title":"Get a DNIS inbound-routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/dnis-routes/{id}","href":"/api-reference/all-endpoints/voice/get-a-dnis-inbound-routing-rule"},{"title":"Replace a DNIS inbound-routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/dnis-routes/{id}","href":"/api-reference/all-endpoints/voice/replace-a-dnis-inbound-routing-rule"},{"title":"Delete a DNIS inbound-routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/dnis-routes/{id}","href":"/api-reference/all-endpoints/voice/delete-a-dnis-inbound-routing-rule"},{"title":"Get business-continuity inbound reroute status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/business-continuity-reroute","href":"/api-reference/all-endpoints/voice/get-business-continuity-inbound-reroute-status"},{"title":"Arm the tenant-wide business-continuity inbound reroute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/business-continuity-reroute/activate","href":"/api-reference/all-endpoints/voice/arm-the-tenant-wide-business-continuity-inbound-reroute"},{"title":"Disarm the business-continuity inbound reroute early","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/business-continuity-reroute/deactivate","href":"/api-reference/all-endpoints/voice/disarm-the-business-continuity-inbound-reroute-early"},{"title":"Get outbound-voice fraud-guard analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/fraud-analytics","href":"/api-reference/all-endpoints/voice/get-outbound-voice-fraud-guard-analytics"},{"title":"Export Wangiri/toll-fraud chargeback evidence (CSV)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/fraud-analytics/evidence-export.csv","href":"/api-reference/all-endpoints/voice/export-wangiritoll-fraud-chargeback-evidence-csv"},{"title":"Get find-me/follow-me ring-ladder capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/find-me-follow-me/capabilities","href":"/api-reference/all-endpoints/voice/get-find-mefollow-me-ring-ladder-capabilities"},{"title":"Preview a find-me/follow-me ring plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/find-me-follow-me/plan","href":"/api-reference/all-endpoints/voice/preview-a-find-mefollow-me-ring-plan"},{"title":"Get call-delegation (boss-admin) capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/delegation/capabilities","href":"/api-reference/all-endpoints/voice/get-call-delegation-boss-admin-capabilities"},{"title":"Preview a call-delegation policy plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/delegation/plan","href":"/api-reference/all-endpoints/voice/preview-a-call-delegation-policy-plan"},{"title":"Get the caller's saved call-delegation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/delegation/policy","href":"/api-reference/all-endpoints/voice/get-the-callers-saved-call-delegation-policy"},{"title":"Save the caller's call-delegation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/delegation/policy","href":"/api-reference/all-endpoints/voice/save-the-callers-call-delegation-policy"},{"title":"Delete the caller's call-delegation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/delegation/policy","href":"/api-reference/all-endpoints/voice/delete-the-callers-call-delegation-policy"},{"title":"Get Microsoft Teams Direct Routing SBC capabilities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/teams-direct-routing/capabilities","href":"/api-reference/all-endpoints/voice/get-microsoft-teams-direct-routing-sbc-capabilities"},{"title":"Resolve a Teams Direct Routing SBC pairing descriptor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/teams-direct-routing/pairing","href":"/api-reference/all-endpoints/voice/resolve-a-teams-direct-routing-sbc-pairing-descriptor"},{"title":"List department voicemail boxes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemail-boxes","href":"/api-reference/all-endpoints/voice/list-department-voicemail-boxes"},{"title":"Create a department voicemail box","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voicemail-boxes","href":"/api-reference/all-endpoints/voice/create-a-department-voicemail-box"},{"title":"Get one department voicemail box","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voicemail-boxes/{id}","href":"/api-reference/all-endpoints/voice/get-one-department-voicemail-box"},{"title":"Update a department voicemail box","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/voicemail-boxes/{id}","href":"/api-reference/all-endpoints/voice/update-a-department-voicemail-box"},{"title":"Delete a department voicemail box","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/voicemail-boxes/{id}","href":"/api-reference/all-endpoints/voice/delete-a-department-voicemail-box"},{"title":"Session cti-embed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/cti-embed/session","href":"/api-reference/all-endpoints/voice/session-cti-embed"},{"title":"Click-to-dial cti-embed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/cti-embed/click-to-dial","href":"/api-reference/all-endpoints/voice/click-to-dial-cti-embed"},{"title":"List whoami","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/cti-embed/whoami","href":"/api-reference/all-endpoints/voice/list-whoami"},{"title":"List coaching-notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/coaching-notes","href":"/api-reference/all-endpoints/voice/list-coaching-notes"},{"title":"Create coaching-notes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/coaching-notes","href":"/api-reference/all-endpoints/voice/create-coaching-notes"},{"title":"Update acknowledge","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/calls/{id}/coaching-notes/{noteId}/acknowledge","href":"/api-reference/all-endpoints/voice/update-acknowledge"},{"title":"List coaching-plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/coaching-plans","href":"/api-reference/all-endpoints/voice/list-coaching-plans"},{"title":"Coaching-plans voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/coaching-plans","href":"/api-reference/all-endpoints/voice/coaching-plans-voice"},{"title":"Get coaching-plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/coaching-plans/{id}","href":"/api-reference/all-endpoints/voice/get-coaching-plans"},{"title":"Update coaching-plans","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/coaching-plans/{id}","href":"/api-reference/all-endpoints/voice/update-coaching-plans"},{"title":"Create close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/coaching-plans/{id}/close","href":"/api-reference/all-endpoints/voice/create-close"},{"title":"List effectiveness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/coaching-plans/{id}/effectiveness","href":"/api-reference/all-endpoints/voice/list-effectiveness"},{"title":"List modules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agent-training/modules","href":"/api-reference/all-endpoints/voice/list-modules"},{"title":"Get modules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agent-training/modules/{moduleId}","href":"/api-reference/all-endpoints/voice/get-modules"},{"title":"Create check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/agent-training/modules/{moduleId}/check","href":"/api-reference/all-endpoints/voice/create-check"},{"title":"List recommendations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/agent-training/recommendations","href":"/api-reference/all-endpoints/voice/list-recommendations"},{"title":"Retrieve-by-code internal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/park/internal/retrieve-by-code","href":"/api-reference/all-endpoints/voice/retrieve-by-code-internal"},{"title":"List park","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/park","href":"/api-reference/all-endpoints/voice/list-park"},{"title":"Park voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/park","href":"/api-reference/all-endpoints/voice/park-voice"},{"title":"Retrieve park","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/park/retrieve","href":"/api-reference/all-endpoints/voice/retrieve-park"},{"title":"Create release","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/park/{id}/release","href":"/api-reference/all-endpoints/voice/create-release"},{"title":"Pull-by-code internal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/call-flip/internal/pull-by-code","href":"/api-reference/all-endpoints/voice/pull-by-code-internal"},{"title":"List call-flip","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/call-flip","href":"/api-reference/all-endpoints/voice/list-call-flip"},{"title":"Call-flip voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/call-flip","href":"/api-reference/all-endpoints/voice/call-flip-voice"},{"title":"Pull call-flip","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/call-flip/pull","href":"/api-reference/all-endpoints/voice/pull-call-flip"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/call-flip/{id}/cancel","href":"/api-reference/all-endpoints/voice/create-cancel"},{"title":"Register-ringing internal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/pickup/internal/register-ringing","href":"/api-reference/all-endpoints/voice/register-ringing-internal"},{"title":"Clear-ringing internal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/pickup/internal/clear-ringing","href":"/api-reference/all-endpoints/voice/clear-ringing-internal"},{"title":"Directed pickup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/pickup/directed","href":"/api-reference/all-endpoints/voice/directed-pickup"},{"title":"Group pickup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/pickup/group","href":"/api-reference/all-endpoints/voice/group-pickup"},{"title":"List pickup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/pickup","href":"/api-reference/all-endpoints/voice/list-pickup"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/mcid/export","href":"/api-reference/all-endpoints/voice/list-export-1"},{"title":"Get mcid","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/mcid/{callId}","href":"/api-reference/all-endpoints/voice/get-mcid"},{"title":"Create mcid","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/mcid/{callId}","href":"/api-reference/all-endpoints/voice/create-mcid"},{"title":"Create start","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/kba/{callId}/start","href":"/api-reference/all-endpoints/voice/create-start"},{"title":"Create verify","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/kba/{callId}/verify","href":"/api-reference/all-endpoints/voice/create-verify"},{"title":"Get kba","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/kba/{callId}","href":"/api-reference/all-endpoints/voice/get-kba"},{"title":"Assets voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/assets","href":"/api-reference/all-endpoints/voice/assets-voice"},{"title":"Tts-preview voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/tts-preview","href":"/api-reference/all-endpoints/voice/tts-preview-voice"},{"title":"TTS audio cache hit/miss stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/tts-cache/stats","href":"/api-reference/all-endpoints/voice/tts-audio-cache-hitmiss-stats"},{"title":"Stt-preview voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/stt-preview","href":"/api-reference/all-endpoints/voice/stt-preview-voice"},{"title":"Get the org's BYO voice-model credential configs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/voice-provider-credential","href":"/api-reference/all-endpoints/voice/get-the-orgs-byo-voice-model-credential-configs"},{"title":"Register a BYO voice-model credential","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/voice-provider-credential/{kind}","href":"/api-reference/all-endpoints/voice/register-a-byo-voice-model-credential"},{"title":"Activate a pending BYO voice-model credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voice-provider-credential/{kind}/activate","href":"/api-reference/all-endpoints/voice/activate-a-pending-byo-voice-model-credential"},{"title":"Rotate the BYO voice-model credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voice-provider-credential/{kind}/rotate","href":"/api-reference/all-endpoints/voice/rotate-the-byo-voice-model-credential"},{"title":"Revoke the BYO voice-model credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/voice-provider-credential/{kind}/revoke","href":"/api-reference/all-endpoints/voice/revoke-the-byo-voice-model-credential"},{"title":"Get the org's on-demand STT provider failover chain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/stt-provider-chain","href":"/api-reference/all-endpoints/voice/get-the-orgs-on-demand-stt-provider-failover-chain"},{"title":"Set the org's on-demand STT provider failover chain","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/stt-provider-chain","href":"/api-reference/all-endpoints/voice/set-the-orgs-on-demand-stt-provider-failover-chain"},{"title":"List qa-scorecard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/qa-scorecard","href":"/api-reference/all-endpoints/voice/list-qa-scorecard"},{"title":"Create qa-scorecard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calls/{id}/qa-scorecard","href":"/api-reference/all-endpoints/voice/create-qa-scorecard"},{"title":"List trend","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/qa-scorecards/trend","href":"/api-reference/all-endpoints/voice/list-trend"},{"title":"Get QC verdict for a recording","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/qc","href":"/api-reference/all-endpoints/voice/get-qc-verdict-for-a-recording"},{"title":"Run QC check on a recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/qc/run","href":"/api-reference/all-endpoints/voice/run-qc-check-on-a-recording"},{"title":"List bookable appointment slots for a queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/queues/{tenantId}/{queueId}/availability","href":"/api-reference/all-endpoints/voice/list-bookable-appointment-slots-for-a-queue"},{"title":"Book a public appointment slot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/queues/{tenantId}/{queueId}/appointments","href":"/api-reference/all-endpoints/voice/book-a-public-appointment-slot"},{"title":"List ring-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ring-groups","href":"/api-reference/all-endpoints/voice/list-ring-groups"},{"title":"Create a ring group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ring-groups","href":"/api-reference/all-endpoints/voice/create-a-ring-group"},{"title":"Get ring-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/ring-groups/{id}","href":"/api-reference/all-endpoints/voice/get-ring-groups"},{"title":"Delete ring-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/ring-groups/{id}","href":"/api-reference/all-endpoints/voice/delete-ring-groups"},{"title":"Patch ring-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/ring-groups/{id}","href":"/api-reference/all-endpoints/voice/patch-ring-groups"},{"title":"Pre-check a ring group member list for cycles","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ring-groups/validate-cycle","href":"/api-reference/all-endpoints/voice/pre-check-a-ring-group-member-list-for-cycles"},{"title":"Validate-warnings ring-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/ring-groups/validate-warnings","href":"/api-reference/all-endpoints/voice/validate-warnings-ring-groups"},{"title":"List paging-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/paging-groups","href":"/api-reference/all-endpoints/voice/list-paging-groups"},{"title":"Paging-groups voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/paging-groups","href":"/api-reference/all-endpoints/voice/paging-groups-voice"},{"title":"Get paging-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/paging-groups/{id}","href":"/api-reference/all-endpoints/voice/get-paging-groups"},{"title":"Delete paging-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/paging-groups/{id}","href":"/api-reference/all-endpoints/voice/delete-paging-groups"},{"title":"Patch paging-groups","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/paging-groups/{id}","href":"/api-reference/all-endpoints/voice/patch-paging-groups"},{"title":"Create page","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/paging-groups/{id}/page","href":"/api-reference/all-endpoints/voice/create-page"},{"title":"Dial intercom","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/intercom/dial","href":"/api-reference/all-endpoints/voice/dial-intercom"},{"title":"Create hangup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/intercom/{intercomCallId}/hangup","href":"/api-reference/all-endpoints/voice/create-hangup-1"},{"title":"List shared-lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/shared-lines","href":"/api-reference/all-endpoints/voice/list-shared-lines"},{"title":"Create a shared line","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/shared-lines","href":"/api-reference/all-endpoints/voice/create-a-shared-line"},{"title":"Get shared-lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/shared-lines/{id}","href":"/api-reference/all-endpoints/voice/get-shared-lines"},{"title":"Delete shared-lines","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/shared-lines/{id}","href":"/api-reference/all-endpoints/voice/delete-shared-lines"},{"title":"Patch shared-lines","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/shared-lines/{id}","href":"/api-reference/all-endpoints/voice/patch-shared-lines"},{"title":"Add a member to a shared line","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/shared-lines/{id}/members","href":"/api-reference/all-endpoints/voice/add-a-member-to-a-shared-line"},{"title":"Delete members","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/shared-lines/{id}/members/{memberId}","href":"/api-reference/all-endpoints/voice/delete-members-1"},{"title":"Poll shared line live status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/shared-lines/{id}/status","href":"/api-reference/all-endpoints/voice/poll-shared-line-live-status"},{"title":"Grab the shared line's answered call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/shared-lines/{id}/grab","href":"/api-reference/all-endpoints/voice/grab-the-shared-lines-answered-call"},{"title":"List calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calendars","href":"/api-reference/all-endpoints/voice/list-calendars"},{"title":"Calendars voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/calendars","href":"/api-reference/all-endpoints/voice/calendars-voice"},{"title":"List usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calendars/{id}/usage","href":"/api-reference/all-endpoints/voice/list-usage-1"},{"title":"Get calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calendars/{id}","href":"/api-reference/all-endpoints/voice/get-calendars"},{"title":"Delete calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/calendars/{id}","href":"/api-reference/all-endpoints/voice/delete-calendars"},{"title":"Patch calendars","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/calendars/{id}","href":"/api-reference/all-endpoints/voice/patch-calendars"},{"title":"List devices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/devices","href":"/api-reference/all-endpoints/voice/list-devices"},{"title":"Devices voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/devices","href":"/api-reference/all-endpoints/voice/devices-voice"},{"title":"Get devices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/devices/{id}","href":"/api-reference/all-endpoints/voice/get-devices"},{"title":"Delete devices","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/devices/{id}","href":"/api-reference/all-endpoints/voice/delete-devices-1"},{"title":"Patch devices","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/devices/{id}","href":"/api-reference/all-endpoints/voice/patch-devices"},{"title":"List key-layout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/devices/{id}/key-layout","href":"/api-reference/all-endpoints/voice/list-key-layout"},{"title":"Create rotate-provisioning","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/devices/{id}/rotate-provisioning","href":"/api-reference/all-endpoints/voice/create-rotate-provisioning"},{"title":"Get provisioning","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/provisioning/{macWithExt}","href":"/api-reference/all-endpoints/voice/get-provisioning"},{"title":"List directory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/directory","href":"/api-reference/all-endpoints/voice/list-directory"},{"title":"Update directory","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/voice/directory","href":"/api-reference/all-endpoints/voice/update-directory"},{"title":"Get phonebook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/phonebook/{macWithExt}","href":"/api-reference/all-endpoints/voice/get-phonebook"},{"title":"Validate a softphone HMAC credential (internal)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/softphone/internal/validate","href":"/api-reference/all-endpoints/voice/validate-a-softphone-hmac-credential-internal"},{"title":"Issue a SIP WSS credential for the browser softphone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/softphone/register","href":"/api-reference/all-endpoints/voice/issue-a-sip-wss-credential-for-the-browser-softphone"},{"title":"Send SMS from extension DID","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/softphone/sms","href":"/api-reference/all-endpoints/voice/send-sms-from-extension-did"},{"title":"Delete credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/softphone/credentials/{username}","href":"/api-reference/all-endpoints/voice/delete-credentials"},{"title":"Escalate voice call to video","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/call-escalation/video","href":"/api-reference/all-endpoints/voice/escalate-voice-call-to-video"},{"title":"List extension SMS conversation threads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/extension-sms/threads","href":"/api-reference/all-endpoints/voice/list-extension-sms-conversation-threads"},{"title":"Get one extension SMS conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/extension-sms/thread","href":"/api-reference/all-endpoints/voice/get-one-extension-sms-conversation"},{"title":"Send an extension SMS","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/extension-sms/send","href":"/api-reference/all-endpoints/voice/send-an-extension-sms"},{"title":"Mark an extension SMS thread read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/extension-sms/read","href":"/api-reference/all-endpoints/voice/mark-an-extension-sms-thread-read"},{"title":"List intelligence","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/intelligence","href":"/api-reference/all-endpoints/voice/list-intelligence"},{"title":"List trends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/intelligence/trends","href":"/api-reference/all-endpoints/voice/list-trends"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/intelligence/calls","href":"/api-reference/all-endpoints/voice/list-calls-1"},{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/intelligence/categories","href":"/api-reference/all-endpoints/voice/list-categories"},{"title":"Categories intelligence","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/intelligence/categories","href":"/api-reference/all-endpoints/voice/categories-intelligence"},{"title":"Delete categories","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/intelligence/categories/{id}","href":"/api-reference/all-endpoints/voice/delete-categories"},{"title":"List custom voice intelligence operators","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/intelligence/operators","href":"/api-reference/all-endpoints/voice/list-custom-voice-intelligence-operators"},{"title":"Create a custom voice intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/voice/intelligence/operators","href":"/api-reference/all-endpoints/voice/create-a-custom-voice-intelligence-operator-adminowner"},{"title":"Deactivate a custom voice intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/voice/intelligence/operators/{id}","href":"/api-reference/all-endpoints/voice/deactivate-a-custom-voice-intelligence-operator-adminowner"},{"title":"Update a custom voice intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/voice/intelligence/operators/{id}","href":"/api-reference/all-endpoints/voice/update-a-custom-voice-intelligence-operator-adminowner"},{"title":"List latency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/latency","href":"/api-reference/all-endpoints/voice/list-latency"},{"title":"List trace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/voice/calls/{id}/trace","href":"/api-reference/all-endpoints/voice/list-trace"}]},{"group":"Auth","pages":[{"title":"Exchange an impersonation token for its grant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/auth/impersonate-exchange","href":"/api-reference/all-endpoints/auth/exchange-an-impersonation-token-for-its-grant"},{"title":"Stage an impersonation token in a cookie","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/auth/impersonate-cookie-set","href":"/api-reference/all-endpoints/auth/stage-an-impersonation-token-in-a-cookie"},{"title":"Consume the staged impersonation cookie","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/auth/impersonate-cookie-consume","href":"/api-reference/all-endpoints/auth/consume-the-staged-impersonation-cookie"},{"title":"Request a password-reset email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/auth/forgot-password","href":"/api-reference/all-endpoints/auth/request-a-password-reset-email"},{"title":"Set a new password with a reset token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/auth/reset-password","href":"/api-reference/all-endpoints/auth/set-a-new-password-with-a-reset-token"},{"title":"Revoke every API key after a password reset","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/auth/post-reset-revoke-api-keys","href":"/api-reference/all-endpoints/auth/revoke-every-api-key-after-a-password-reset"},{"title":"Record terms and privacy consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/auth/consent","href":"/api-reference/all-endpoints/auth/record-terms-and-privacy-consent"}]},{"group":"CDP","pages":[{"title":"Server-side tagging container — first-party event ingest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cdp/v1/{ingest_id}/container/track","href":"/api-reference/all-endpoints/cdp/server-side-tagging-container-—-first-party-event-ingest"},{"title":"List CDP ingest secrets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/secrets","href":"/api-reference/all-endpoints/cdp/list-cdp-ingest-secrets"},{"title":"Mint a CDP ingest secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/secrets","href":"/api-reference/all-endpoints/cdp/mint-a-cdp-ingest-secret"},{"title":"Revoke a CDP ingest secret","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/secrets/{id}","href":"/api-reference/all-endpoints/cdp/revoke-a-cdp-ingest-secret"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/subscriptions","href":"/api-reference/all-endpoints/cdp/list-subscriptions"},{"title":"Subscriptions cdp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/subscriptions","href":"/api-reference/all-endpoints/cdp/subscriptions-cdp"},{"title":"Get subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/subscriptions/{id}","href":"/api-reference/all-endpoints/cdp/get-subscriptions"},{"title":"Delete subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/subscriptions/{id}","href":"/api-reference/all-endpoints/cdp/delete-subscriptions"},{"title":"Patch subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/subscriptions/{id}","href":"/api-reference/all-endpoints/cdp/patch-subscriptions"},{"title":"Create reset-circuit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/subscriptions/{id}/reset-circuit","href":"/api-reference/all-endpoints/cdp/create-reset-circuit"},{"title":"Send a synchronous test event to a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/subscriptions/{id}/test-event","href":"/api-reference/all-endpoints/cdp/send-a-synchronous-test-event-to-a-subscription"},{"title":"Create rotate-secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/subscriptions/{id}/rotate-secret","href":"/api-reference/all-endpoints/cdp/create-rotate-secret"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/subscriptions/{id}/deliveries","href":"/api-reference/all-endpoints/cdp/list-deliveries"},{"title":"Create retry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/deliveries/{id}/retry","href":"/api-reference/all-endpoints/cdp/create-retry"},{"title":"List dlq","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/dlq","href":"/api-reference/all-endpoints/cdp/list-dlq"},{"title":"Create replay-failed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/subscriptions/{id}/replay-failed","href":"/api-reference/all-endpoints/cdp/create-replay-failed"},{"title":"Backfill events","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/events/backfill","href":"/api-reference/all-endpoints/cdp/backfill-events"},{"title":"Get a subscription's delivery SLA over a sliding window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/subscriptions/{id}/sla","href":"/api-reference/all-endpoints/cdp/get-a-subscriptions-delivery-sla-over-a-sliding-window"},{"title":"List reverse-ETL sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/sources","href":"/api-reference/all-endpoints/cdp/list-reverse-etl-sources"},{"title":"Create a reverse-ETL source","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/sources","href":"/api-reference/all-endpoints/cdp/create-a-reverse-etl-source"},{"title":"Delete a reverse-ETL source","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/sources/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-reverse-etl-source"},{"title":"Update a reverse-ETL source","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/sources/{id}","href":"/api-reference/all-endpoints/cdp/update-a-reverse-etl-source"},{"title":"Get the newest CDP events for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/events/recent","href":"/api-reference/all-endpoints/cdp/get-the-newest-cdp-events-for-the-tenant"},{"title":"Scroll one identity's consent ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/consent","href":"/api-reference/all-endpoints/cdp/scroll-one-identitys-consent-ledger"},{"title":"Record a consent decision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/consent","href":"/api-reference/all-endpoints/cdp/record-a-consent-decision"},{"title":"Read-only consent gate for one identity + purpose","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/consent/check","href":"/api-reference/all-endpoints/cdp/read-only-consent-gate-for-one-identity-+-purpose"},{"title":"Evaluate a single consent verdict for a contact/channel pair","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/consent/check","href":"/api-reference/all-endpoints/cdp/evaluate-a-single-consent-verdict-for-a-contactchannel-pair"},{"title":"List identities whose consent grants are due for re-consent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/consent/renewals","href":"/api-reference/all-endpoints/cdp/list-identities-whose-consent-grants-are-due-for-re-consent"},{"title":"List reverse-etl","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl","href":"/api-reference/all-endpoints/cdp/list-reverse-etl"},{"title":"Patch reverse-etl","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/reverse-etl","href":"/api-reference/all-endpoints/cdp/patch-reverse-etl"},{"title":"Get reverse-ETL warehouse config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/warehouse/{warehouse}","href":"/api-reference/all-endpoints/cdp/get-reverse-etl-warehouse-config"},{"title":"Update reverse-ETL warehouse config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/reverse-etl/warehouse/{warehouse}","href":"/api-reference/all-endpoints/cdp/update-reverse-etl-warehouse-config"},{"title":"Parse dbt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/reverse-etl/dbt/parse","href":"/api-reference/all-endpoints/cdp/parse-dbt"},{"title":"List sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/dbt/sources","href":"/api-reference/all-endpoints/cdp/list-sources"},{"title":"Sources dbt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/reverse-etl/dbt/sources","href":"/api-reference/all-endpoints/cdp/sources-dbt"},{"title":"Get sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/dbt/sources/{id}","href":"/api-reference/all-endpoints/cdp/get-sources"},{"title":"Delete sources","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/reverse-etl/dbt/sources/{id}","href":"/api-reference/all-endpoints/cdp/delete-sources"},{"title":"Patch sources","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/reverse-etl/dbt/sources/{id}","href":"/api-reference/all-endpoints/cdp/patch-sources"},{"title":"List reverse-ETL sync-run status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/sync-runs","href":"/api-reference/all-endpoints/cdp/list-reverse-etl-sync-run-status"},{"title":"Reverse-ETL destinations panel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/destinations","href":"/api-reference/all-endpoints/cdp/reverse-etl-destinations-panel"},{"title":"Reverse-ETL segment export destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/segment-exports","href":"/api-reference/all-endpoints/cdp/reverse-etl-segment-export-destinations"},{"title":"Reverse-ETL profile export destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/profile-exports","href":"/api-reference/all-endpoints/cdp/reverse-etl-profile-export-destinations"},{"title":"List recent CRM/reverse-ETL sync runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/sync-run-log/runs","href":"/api-reference/all-endpoints/cdp/list-recent-crmreverse-etl-sync-runs"},{"title":"Get one sync run's failed rows bucketed by error class","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/sync-run-log/runs/{runId}","href":"/api-reference/all-endpoints/cdp/get-one-sync-runs-failed-rows-bucketed-by-error-class"},{"title":"Request a reverse-ETL backfill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/reverse-etl/{destination}/backfill","href":"/api-reference/all-endpoints/cdp/request-a-reverse-etl-backfill"},{"title":"List reverse-ETL warehouse-egress schema contracts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/schema-contracts","href":"/api-reference/all-endpoints/cdp/list-reverse-etl-warehouse-egress-schema-contracts"},{"title":"Get one reverse-ETL warehouse-egress schema contract","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/reverse-etl/schema-contracts/{table}","href":"/api-reference/all-endpoints/cdp/get-one-reverse-etl-warehouse-egress-schema-contract"},{"title":"Trigger an on-demand reverse-ETL sync","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/reverse-etl/{destination}/sync-now","href":"/api-reference/all-endpoints/cdp/trigger-an-on-demand-reverse-etl-sync"},{"title":"Read every ad-platform audience destination mapping","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/config","href":"/api-reference/all-endpoints/cdp/read-every-ad-platform-audience-destination-mapping"},{"title":"Patch config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/audience/config/{platform}","href":"/api-reference/all-endpoints/cdp/patch-config"},{"title":"Push a member batch to a destination audience (or queue it for approval)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/activate/{platform}","href":"/api-reference/all-endpoints/cdp/push-a-member-batch-to-a-destination-audience-or-queue-it-for-approval"},{"title":"Create preflight","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/preflight/{platform}","href":"/api-reference/all-endpoints/cdp/create-preflight"},{"title":"List recent audience activation runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/activations","href":"/api-reference/all-endpoints/cdp/list-recent-audience-activation-runs"},{"title":"Read one activation run and its per-member error feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/activations/{id}","href":"/api-reference/all-endpoints/cdp/read-one-activation-run-and-its-per-member-error-feedback"},{"title":"Redispatch a failed or skipped activation run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/activations/{id}/retry","href":"/api-reference/all-endpoints/cdp/redispatch-a-failed-or-skipped-activation-run"},{"title":"Record per-arm conversions and compute the incrementality report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/activations/{id}/lift","href":"/api-reference/all-endpoints/cdp/record-per-arm-conversions-and-compute-the-incrementality-report"},{"title":"List queued activation approval requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/approvals","href":"/api-reference/all-endpoints/cdp/list-queued-activation-approval-requests"},{"title":"Approve or reject a queued activation request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/approvals/{id}/decision","href":"/api-reference/all-endpoints/cdp/approve-or-reject-a-queued-activation-request"},{"title":"Read the activation approval policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/approvals/settings","href":"/api-reference/all-endpoints/cdp/read-the-activation-approval-policy"},{"title":"Enable or disable the activation approval gate","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/audience/approvals/settings","href":"/api-reference/all-endpoints/cdp/enable-or-disable-the-activation-approval-gate"},{"title":"Get UID2 configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/uid2/config","href":"/api-reference/all-endpoints/cdp/get-uid2-configuration"},{"title":"Update UID2 configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/uid2/config","href":"/api-reference/all-endpoints/cdp/update-uid2-configuration"},{"title":"Mint uid2","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/uid2/mint","href":"/api-reference/all-endpoints/cdp/mint-uid2"},{"title":"Tokens rotate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/uid2/rotate/tokens","href":"/api-reference/all-endpoints/cdp/tokens-rotate"},{"title":"Buckets rotate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/uid2/rotate/buckets","href":"/api-reference/all-endpoints/cdp/buckets-rotate"},{"title":"Export uid2","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/uid2/export","href":"/api-reference/all-endpoints/cdp/export-uid2"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/uid2/runs","href":"/api-reference/all-endpoints/cdp/list-runs"},{"title":"Read every ad-platform conversion-forwarding mapping for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/conversions/config","href":"/api-reference/all-endpoints/cdp/read-every-ad-platform-conversion-forwarding-mapping-for-the-tenant"},{"title":"Update one ad platform's conversion-forwarding mapping","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/conversions/config/{platform}","href":"/api-reference/all-endpoints/cdp/update-one-ad-platforms-conversion-forwarding-mapping"},{"title":"Forward conversion events to an ad platform","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/conversions/forward/{platform}","href":"/api-reference/all-endpoints/cdp/forward-conversion-events-to-an-ad-platform"},{"title":"List conversion-forward history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/conversions/forwards","href":"/api-reference/all-endpoints/cdp/list-conversion-forward-history"},{"title":"List webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/webhook","href":"/api-reference/all-endpoints/cdp/list-webhook"},{"title":"Patch webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/audience/webhook","href":"/api-reference/all-endpoints/cdp/patch-webhook"},{"title":"Activate webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/audience/webhook/activate","href":"/api-reference/all-endpoints/cdp/activate-webhook"},{"title":"List activations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/audience/webhook/activations","href":"/api-reference/all-endpoints/cdp/list-activations"},{"title":"List CRM object-sync destination configs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/crm-sync/config","href":"/api-reference/all-endpoints/cdp/list-crm-object-sync-destination-configs"},{"title":"Update one CRM object-sync destination","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/crm-sync/config/{destination}","href":"/api-reference/all-endpoints/cdp/update-one-crm-object-sync-destination"},{"title":"Run an on-demand CRM object sync","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/crm-sync/run/{destination}","href":"/api-reference/all-endpoints/cdp/run-an-on-demand-crm-object-sync"},{"title":"List CRM object-sync run history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/crm-sync/runs","href":"/api-reference/all-endpoints/cdp/list-crm-object-sync-run-history"},{"title":"List ERP object-sync destination configs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/erp-sync/config","href":"/api-reference/all-endpoints/cdp/list-erp-object-sync-destination-configs"},{"title":"Update one ERP object-sync mapping","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/erp-sync/config/{destination}","href":"/api-reference/all-endpoints/cdp/update-one-erp-object-sync-mapping"},{"title":"Run an on-demand ERP object sync","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/erp-sync/run/{destination}","href":"/api-reference/all-endpoints/cdp/run-an-on-demand-erp-object-sync"},{"title":"List ERP object-sync runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/erp-sync/runs","href":"/api-reference/all-endpoints/cdp/list-erp-object-sync-runs"},{"title":"Get the streaming destination config for a provider","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/streaming-destinations/{provider}","href":"/api-reference/all-endpoints/cdp/get-the-streaming-destination-config-for-a-provider"},{"title":"Patch streaming-destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/streaming-destinations/{provider}","href":"/api-reference/all-endpoints/cdp/patch-streaming-destinations"},{"title":"Get object-storage export destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/object-storage-destinations/{provider}","href":"/api-reference/all-endpoints/cdp/get-object-storage-export-destination-config"},{"title":"Update object-storage export destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/object-storage-destinations/{provider}","href":"/api-reference/all-endpoints/cdp/update-object-storage-export-destination-config"},{"title":"Read the published interaction data-share schema contracts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/interaction-data-share/schema-contract","href":"/api-reference/all-endpoints/cdp/read-the-published-interaction-data-share-schema-contracts"},{"title":"Get an interaction data-share target configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/interaction-data-share/{provider}","href":"/api-reference/all-endpoints/cdp/get-an-interaction-data-share-target-configuration"},{"title":"Update an interaction data-share target configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/interaction-data-share/{provider}","href":"/api-reference/all-endpoints/cdp/update-an-interaction-data-share-target-configuration"},{"title":"Request a historical backfill for a share target","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/interaction-data-share/{provider}/backfill","href":"/api-reference/all-endpoints/cdp/request-a-historical-backfill-for-a-share-target"},{"title":"Get object-storage file-drop source config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/object-storage-source-config/{provider}","href":"/api-reference/all-endpoints/cdp/get-object-storage-file-drop-source-config"},{"title":"Update object-storage file-drop source config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/object-storage-source-config/{provider}","href":"/api-reference/all-endpoints/cdp/update-object-storage-file-drop-source-config"},{"title":"Get Meta Conversions API destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/meta-capi-destination","href":"/api-reference/all-endpoints/cdp/get-meta-conversions-api-destination-config"},{"title":"Update Meta Conversions API destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/meta-capi-destination","href":"/api-reference/all-endpoints/cdp/update-meta-conversions-api-destination-config"},{"title":"Read the TikTok Events destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/tiktok-events-destination","href":"/api-reference/all-endpoints/cdp/read-the-tiktok-events-destination-config"},{"title":"Update the TikTok Events destination config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/tiktok-events-destination","href":"/api-reference/all-endpoints/cdp/update-the-tiktok-events-destination-config"},{"title":"Read a contact's stored AI traits without recomputing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/contacts/{id}/ai-traits","href":"/api-reference/all-endpoints/cdp/read-a-contacts-stored-ai-traits-without-recomputing"},{"title":"Recompute a contact's AI traits on demand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/contacts/{id}/ai-traits/refresh","href":"/api-reference/all-endpoints/cdp/recompute-a-contacts-ai-traits-on-demand"},{"title":"Record a GDPR Art-22 contest against a contact's AI traits","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/contacts/{id}/ai-traits/contest","href":"/api-reference/all-endpoints/cdp/record-a-gdpr-art-22-contest-against-a-contacts-ai-traits"},{"title":"Read one contact's full consent ledger across all channels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/consent/{contactId}","href":"/api-reference/all-endpoints/cdp/read-one-contacts-full-consent-ledger-across-all-channels"},{"title":"Decode ad-consent signals","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/ad-consent/decode","href":"/api-reference/all-endpoints/cdp/decode-ad-consent-signals"},{"title":"Get the consent-revocation propagation status trail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/consent/{contactId}/{channel}/propagate-revocation","href":"/api-reference/all-endpoints/cdp/get-the-consent-revocation-propagation-status-trail"},{"title":"Propagate a contact's channel consent revocation to destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/consent/{contactId}/{channel}/propagate-revocation","href":"/api-reference/all-endpoints/cdp/propagate-a-contacts-channel-consent-revocation-to-destinations"},{"title":"Get GDPR erasure per-destination propagation modes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/erasure/destination-modes","href":"/api-reference/all-endpoints/cdp/get-gdpr-erasure-per-destination-propagation-modes"},{"title":"Update GDPR erasure per-destination propagation modes","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/erasure/destination-modes","href":"/api-reference/all-endpoints/cdp/update-gdpr-erasure-per-destination-propagation-modes"},{"title":"Get the GDPR erasure propagation status trail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/erasure/{erasureId}/propagate","href":"/api-reference/all-endpoints/cdp/get-the-gdpr-erasure-propagation-status-trail"},{"title":"Propagate a completed GDPR erasure to downstream destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/erasure/{erasureId}/propagate","href":"/api-reference/all-endpoints/cdp/propagate-a-completed-gdpr-erasure-to-downstream-destinations"},{"title":"Auto-derive contact trait tags via LLM","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/traits/auto-derive","href":"/api-reference/all-endpoints/cdp/auto-derive-contact-trait-tags-via-llm"},{"title":"List tracking-plan events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/tracking-plan","href":"/api-reference/all-endpoints/cdp/list-tracking-plan-events"},{"title":"Upsert a tracking-plan event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/tracking-plan","href":"/api-reference/all-endpoints/cdp/upsert-a-tracking-plan-event"},{"title":"Delete a tracking-plan event","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/tracking-plan/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-tracking-plan-event"},{"title":"List violations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/tracking-plan/violations","href":"/api-reference/all-endpoints/cdp/list-violations"},{"title":"List settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/tracking-plan/settings","href":"/api-reference/all-endpoints/cdp/list-settings"},{"title":"Patch settings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/tracking-plan/settings","href":"/api-reference/all-endpoints/cdp/patch-settings"},{"title":"Tail the live CDP event stream with filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/events/debug","href":"/api-reference/all-endpoints/cdp/tail-the-live-cdp-event-stream-with-filters"},{"title":"Export raw CDP events in chronological order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/events/export","href":"/api-reference/all-endpoints/cdp/export-raw-cdp-events-in-chronological-order"},{"title":"Read the CDP data catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/data-catalog","href":"/api-reference/all-endpoints/cdp/read-the-cdp-data-catalog"},{"title":"Forecast the CDP event-volume bill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/cost-forecast","href":"/api-reference/all-endpoints/cdp/forecast-the-cdp-event-volume-bill"},{"title":"Compare Segment MTU pricing with Orbit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/mtu-cost-comparison","href":"/api-reference/all-endpoints/cdp/compare-segment-mtu-pricing-with-orbit"},{"title":"Read contact data-quality ratios","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/data-quality","href":"/api-reference/all-endpoints/cdp/read-contact-data-quality-ratios"},{"title":"List event-volume-anomaly","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/event-volume-anomaly","href":"/api-reference/all-endpoints/cdp/list-event-volume-anomaly"},{"title":"List the contact attributes available for distribution exploration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/attribute-distribution/attributes","href":"/api-reference/all-endpoints/cdp/list-the-contact-attributes-available-for-distribution-exploration"},{"title":"Read one attribute's value distribution and cardinality snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/attribute-distribution","href":"/api-reference/all-endpoints/cdp/read-one-attributes-value-distribution-and-cardinality-snapshot"},{"title":"Per-segment audience insights (distinguishing traits)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/segments/{id}/insights","href":"/api-reference/all-endpoints/cdp/per-segment-audience-insights-distinguishing-traits"},{"title":"List CDP event schemas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/schemas","href":"/api-reference/all-endpoints/cdp/list-cdp-event-schemas"},{"title":"Create or update a CDP event schema","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/schemas","href":"/api-reference/all-endpoints/cdp/create-or-update-a-cdp-event-schema"},{"title":"Get a CDP event schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/schemas/{event_type}","href":"/api-reference/all-endpoints/cdp/get-a-cdp-event-schema"},{"title":"Delete a CDP event schema","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/schemas/{event_type}","href":"/api-reference/all-endpoints/cdp/delete-a-cdp-event-schema"},{"title":"Update a CDP event schema","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/schemas/{event_type}","href":"/api-reference/all-endpoints/cdp/update-a-cdp-event-schema"},{"title":"List the tenant's identity rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/identity-rules","href":"/api-reference/all-endpoints/cdp/list-the-tenants-identity-rules"},{"title":"Upsert an identity rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/identity-rules","href":"/api-reference/all-endpoints/cdp/upsert-an-identity-rule"},{"title":"Delete an identity rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/identity-rules/{id}","href":"/api-reference/all-endpoints/cdp/delete-an-identity-rule"},{"title":"Dry-run deterministic identity resolution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/preview","href":"/api-reference/all-endpoints/cdp/dry-run-deterministic-identity-resolution"},{"title":"Execute deterministic identity resolution merges","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/run","href":"/api-reference/all-endpoints/cdp/execute-deterministic-identity-resolution-merges"},{"title":"Apply operator-approved identity merges","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/apply","href":"/api-reference/all-endpoints/cdp/apply-operator-approved-identity-merges"},{"title":"What-if simulation for identity match rules + survivorship policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/simulate","href":"/api-reference/all-endpoints/cdp/what-if-simulation-for-identity-match-rules-+-survivorship-policy"},{"title":"Next progressive-profiling fields to ask (only fields not yet known)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/progressive-profiling/next","href":"/api-reference/all-endpoints/cdp/next-progressive-profiling-fields-to-ask-only-fields-not-yet-known"},{"title":"Capture progressive-profiling answers + return the next fields","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/progressive-profiling/capture","href":"/api-reference/all-endpoints/cdp/capture-progressive-profiling-answers-+-return-the-next-fields"},{"title":"Get a profile's traits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/traits","href":"/api-reference/all-endpoints/cdp/get-a-profiles-traits"},{"title":"List a profile's CDP events by user id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/events","href":"/api-reference/all-endpoints/cdp/list-a-profiles-cdp-events-by-user-id"},{"title":"List a profile's external identifiers by user id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/external_ids","href":"/api-reference/all-endpoints/cdp/list-a-profiles-external-identifiers-by-user-id"},{"title":"Get a profile's traits by email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-email/{email}/traits","href":"/api-reference/all-endpoints/cdp/get-a-profiles-traits-by-email"},{"title":"List a profile's CDP events by email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-email/{email}/events","href":"/api-reference/all-endpoints/cdp/list-a-profiles-cdp-events-by-email"},{"title":"Get a profile's traits by phone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-phone/{phone}/traits","href":"/api-reference/all-endpoints/cdp/get-a-profiles-traits-by-phone"},{"title":"List a profile's CDP events by phone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-phone/{phone}/events","href":"/api-reference/all-endpoints/cdp/list-a-profiles-cdp-events-by-phone"},{"title":"Get a profile's traits by anonymous id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/traits","href":"/api-reference/all-endpoints/cdp/get-a-profiles-traits-by-anonymous-id"},{"title":"List a profile's CDP events by anonymous id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/events","href":"/api-reference/all-endpoints/cdp/list-a-profiles-cdp-events-by-anonymous-id"},{"title":"List the segments a profile belongs to","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/segments","href":"/api-reference/all-endpoints/cdp/list-the-segments-a-profile-belongs-to"},{"title":"List a profile's segment memberships by email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-email/{email}/segments","href":"/api-reference/all-endpoints/cdp/list-a-profiles-segment-memberships-by-email"},{"title":"List a profile's segment memberships by phone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-phone/{phone}/segments","href":"/api-reference/all-endpoints/cdp/list-a-profiles-segment-memberships-by-phone"},{"title":"List a profile's segment memberships by anonymous id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/segments","href":"/api-reference/all-endpoints/cdp/list-a-profiles-segment-memberships-by-anonymous-id"},{"title":"Evaluate segment membership for a profile in real time","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/segments/evaluate","href":"/api-reference/all-endpoints/cdp/evaluate-segment-membership-for-a-profile-in-real-time"},{"title":"Evaluate segment qualification by email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-email/{email}/segments/evaluate","href":"/api-reference/all-endpoints/cdp/evaluate-segment-qualification-by-email"},{"title":"Evaluate segment qualification by phone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-phone/{phone}/segments/evaluate","href":"/api-reference/all-endpoints/cdp/evaluate-segment-qualification-by-phone"},{"title":"Evaluate segment qualification by anonymous id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/segments/evaluate","href":"/api-reference/all-endpoints/cdp/evaluate-segment-qualification-by-anonymous-id"},{"title":"Get the agent memory plane for a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/memory","href":"/api-reference/all-endpoints/cdp/get-the-agent-memory-plane-for-a-profile"},{"title":"Read a profile's memory surface by email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-email/{email}/memory","href":"/api-reference/all-endpoints/cdp/read-a-profiles-memory-surface-by-email"},{"title":"Read a profile's memory surface by phone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-phone/{phone}/memory","href":"/api-reference/all-endpoints/cdp/read-a-profiles-memory-surface-by-phone"},{"title":"Read a profile's memory surface by anonymous id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/memory","href":"/api-reference/all-endpoints/cdp/read-a-profiles-memory-surface-by-anonymous-id"},{"title":"Probabilistic identity match for one inbound profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/probabilistic-match","href":"/api-reference/all-endpoints/cdp/probabilistic-identity-match-for-one-inbound-profile"},{"title":"List steward match-review queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/identity-resolution/match-reviews","href":"/api-reference/all-endpoints/cdp/list-steward-match-review-queue"},{"title":"Enqueue a scored candidate pair for steward review","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/match-reviews","href":"/api-reference/all-endpoints/cdp/enqueue-a-scored-candidate-pair-for-steward-review"},{"title":"Record an accept / reject verdict on a match review","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-resolution/match-reviews/{id}/verdict","href":"/api-reference/all-endpoints/cdp/record-an-accept-reject-verdict-on-a-match-review"},{"title":"Privacy-safe clean-room audience overlap match","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/clean-room/match","href":"/api-reference/all-endpoints/cdp/privacy-safe-clean-room-audience-overlap-match"},{"title":"Tokenize sensitive contact identifiers (PII vault)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/pii-vault/tokenize","href":"/api-reference/all-endpoints/cdp/tokenize-sensitive-contact-identifiers-pii-vault"},{"title":"Detokenize PII vault envelopes back to cleartext","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/pii-vault/detokenize","href":"/api-reference/all-endpoints/cdp/detokenize-pii-vault-envelopes-back-to-cleartext"},{"title":"List traits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/traits","href":"/api-reference/all-endpoints/cdp/list-traits"},{"title":"Traits cdp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/traits","href":"/api-reference/all-endpoints/cdp/traits-cdp"},{"title":"Get a computed trait","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/traits/{id}","href":"/api-reference/all-endpoints/cdp/get-a-computed-trait"},{"title":"Delete traits","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/traits/{id}","href":"/api-reference/all-endpoints/cdp/delete-traits"},{"title":"Update a computed trait","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/traits/{id}","href":"/api-reference/all-endpoints/cdp/update-a-computed-trait"},{"title":"Get a profile's trait change history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/trait-history","href":"/api-reference/all-endpoints/cdp/get-a-profiles-trait-change-history"},{"title":"Run a conversion funnel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/funnel","href":"/api-reference/all-endpoints/cdp/run-a-conversion-funnel"},{"title":"Run a cohort-retention report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/cohort-retention","href":"/api-reference/all-endpoints/cdp/run-a-cohort-retention-report"},{"title":"Mine common journey paths","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/path-discovery","href":"/api-reference/all-endpoints/cdp/mine-common-journey-paths"},{"title":"Compute an event transition matrix","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/transition-matrix","href":"/api-reference/all-endpoints/cdp/compute-an-event-transition-matrix"},{"title":"Run multi-touch attribution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/attribution","href":"/api-reference/all-endpoints/cdp/run-multi-touch-attribution"},{"title":"Attribute revenue across touchpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/revenue-attribution","href":"/api-reference/all-endpoints/cdp/attribute-revenue-across-touchpoints"},{"title":"Fit a marketing mix model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/analytics/marketing-mix-model","href":"/api-reference/all-endpoints/cdp/fit-a-marketing-mix-model"},{"title":"List account-level scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/accounts/scores","href":"/api-reference/all-endpoints/cdp/list-account-level-scores"},{"title":"Get one account's score detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/accounts/score","href":"/api-reference/all-endpoints/cdp/get-one-accounts-score-detail"},{"title":"List B2B account profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/accounts/profiles","href":"/api-reference/all-endpoints/cdp/list-b2b-account-profiles"},{"title":"Fetch one B2B account profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/accounts/profile","href":"/api-reference/all-endpoints/cdp/fetch-one-b2b-account-profile"},{"title":"Read a contact's relationship graph (households and related contacts)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/contacts/{contact_id}/relationships","href":"/api-reference/all-endpoints/cdp/read-a-contacts-relationship-graph-households-and-related-contacts"},{"title":"Decide decisioning","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/decisioning/decide","href":"/api-reference/all-endpoints/cdp/decide-decisioning"},{"title":"Rank next-best products for a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/recommendations/rank","href":"/api-reference/all-endpoints/cdp/rank-next-best-products-for-a-profile"},{"title":"Decide the best eligible offer for one contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/offers/decide","href":"/api-reference/all-endpoints/cdp/decide-the-best-eligible-offer-for-one-contact"},{"title":"List persisted CDP offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/offers","href":"/api-reference/all-endpoints/cdp/list-persisted-cdp-offers"},{"title":"Create or update a CDP offer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/offers","href":"/api-reference/all-endpoints/cdp/create-or-update-a-cdp-offer"},{"title":"Delete a CDP offer","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/offers/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-cdp-offer"},{"title":"List available predictive models","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/predictive-models","href":"/api-reference/all-endpoints/cdp/list-available-predictive-models"},{"title":"Train a predictive model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/predictive-models/{model}/train","href":"/api-reference/all-endpoints/cdp/train-a-predictive-model"},{"title":"Score profiles with a predictive model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/predictive-models/{model}/score","href":"/api-reference/all-endpoints/cdp/score-profiles-with-a-predictive-model"},{"title":"Materialise a predictive-model segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/predictive-models/{model}/activate","href":"/api-reference/all-endpoints/cdp/materialise-a-predictive-model-segment"},{"title":"Check a predictive model for input drift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/predictive-models/{model}/drift","href":"/api-reference/all-endpoints/cdp/check-a-predictive-model-for-input-drift"},{"title":"Train an uplift (persuadability) model for a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/predictive-models/uplift/train","href":"/api-reference/all-endpoints/cdp/train-an-uplift-persuadability-model-for-a-campaign"},{"title":"Score persuadability (uplift)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/predictive-models/uplift/score","href":"/api-reference/all-endpoints/cdp/score-persuadability-uplift"},{"title":"Score one contact synchronously and evaluate a send-time decisioning gate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/inline-score","href":"/api-reference/all-endpoints/cdp/score-one-contact-synchronously-and-evaluate-a-send-time-decisioning-gate"},{"title":"List bands","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/churn-risk/bands","href":"/api-reference/all-endpoints/cdp/list-bands"},{"title":"Preview segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/churn-risk/segment/preview","href":"/api-reference/all-endpoints/cdp/preview-segment"},{"title":"Segment churn-risk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/churn-risk/segment","href":"/api-reference/all-endpoints/cdp/segment-churn-risk"},{"title":"Read the CLV value-tier distribution","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/clv/tiers","href":"/api-reference/all-endpoints/cdp/read-the-clv-value-tier-distribution"},{"title":"Preview a CLV-threshold contact cohort","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/clv/segment/preview","href":"/api-reference/all-endpoints/cdp/preview-a-clv-threshold-contact-cohort"},{"title":"Materialise a CLV-threshold contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/clv/segment","href":"/api-reference/all-endpoints/cdp/materialise-a-clv-threshold-contact-segment"},{"title":"List features available to BYO external models","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/external-models/feature-catalog","href":"/api-reference/all-endpoints/cdp/list-features-available-to-byo-external-models"},{"title":"Score profiles with a bring-your-own external model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/external-models/score","href":"/api-reference/all-endpoints/cdp/score-profiles-with-a-bring-your-own-external-model"},{"title":"Probabilistic merge-candidate review queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/identity/merge-candidates","href":"/api-reference/all-endpoints/cdp/probabilistic-merge-candidate-review-queue"},{"title":"Read a profile's field lineage by user id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/field-lineage","href":"/api-reference/all-endpoints/cdp/read-a-profiles-field-lineage-by-user-id"},{"title":"Read a profile's identity graph by user id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-user-id/{user_id}/identity-graph","href":"/api-reference/all-endpoints/cdp/read-a-profiles-identity-graph-by-user-id"},{"title":"Split a mis-stitched identifier off a profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/profiles/by-user-id/{user_id}/identity-graph/split","href":"/api-reference/all-endpoints/cdp/split-a-mis-stitched-identifier-off-a-profile"},{"title":"Get an anonymous visitor's device/cookie identity graph","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/profiles/by-anonymous-id/{anonymous_id}/device-graph","href":"/api-reference/all-endpoints/cdp/get-an-anonymous-visitors-devicecookie-identity-graph"},{"title":"Stitch an anonymous session into a known contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/identity-stitch","href":"/api-reference/all-endpoints/cdp/stitch-an-anonymous-session-into-a-known-contact"},{"title":"Get CDP data residency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/data-residency","href":"/api-reference/all-endpoints/cdp/get-cdp-data-residency"},{"title":"Browse the cloud-app source connector catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/source-catalog","href":"/api-reference/all-endpoints/cdp/browse-the-cloud-app-source-connector-catalog"},{"title":"Get one source connector's full spec","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/source-catalog/{connector_id}","href":"/api-reference/all-endpoints/cdp/get-one-source-connectors-full-spec"},{"title":"Check whether a source connector is activatable today","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/source-catalog/{connector_id}/activation","href":"/api-reference/all-endpoints/cdp/check-whether-a-source-connector-is-activatable-today"},{"title":"Validate a source-connector config pre-connect","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/source-catalog/{connector_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-a-source-connector-config-pre-connect"},{"title":"Start connecting a source connector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/source-catalog/{connector_id}/connect","href":"/api-reference/all-endpoints/cdp/start-connecting-a-source-connector"},{"title":"Trigger a sync now for a connected source","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/source-catalog/{connector_id}/sync","href":"/api-reference/all-endpoints/cdp/trigger-a-sync-now-for-a-connected-source"},{"title":"Watch a connected source's live sync status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/source-catalog/{connector_id}/sync-status","href":"/api-reference/all-endpoints/cdp/watch-a-connected-sources-live-sync-status"},{"title":"List object-storage source connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/object-storage-sources","href":"/api-reference/all-endpoints/cdp/list-object-storage-source-connectors"},{"title":"Get one object-storage source connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/object-storage-sources/{connector_id}","href":"/api-reference/all-endpoints/cdp/get-one-object-storage-source-connector"},{"title":"Validate an object-storage source config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/object-storage-sources/{connector_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-an-object-storage-source-config"},{"title":"List event-bus-sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/event-bus-sources","href":"/api-reference/all-endpoints/cdp/list-event-bus-sources"},{"title":"Get event-bus-sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/event-bus-sources/{connector_id}","href":"/api-reference/all-endpoints/cdp/get-event-bus-sources"},{"title":"Create validate-config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/event-bus-sources/{connector_id}/validate-config","href":"/api-reference/all-endpoints/cdp/create-validate-config"},{"title":"Create preview-message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/event-bus-sources/{connector_id}/preview-message","href":"/api-reference/all-endpoints/cdp/create-preview-message"},{"title":"Create consume-batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/event-bus-sources/{connector_id}/consume-batch","href":"/api-reference/all-endpoints/cdp/create-consume-batch"},{"title":"List streaming-sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/streaming-sources","href":"/api-reference/all-endpoints/cdp/list-streaming-sources"},{"title":"Get streaming-sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/streaming-sources/{source_id}","href":"/api-reference/all-endpoints/cdp/get-streaming-sources"},{"title":"List cloud-storage file source catalog entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/file-sources","href":"/api-reference/all-endpoints/cdp/list-cloud-storage-file-source-catalog-entries"},{"title":"Get one cloud-storage file source","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/file-sources/{source_id}","href":"/api-reference/all-endpoints/cdp/get-one-cloud-storage-file-source"},{"title":"Validate a file-source connect-form config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/file-sources/{source_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-a-file-source-connect-form-config"},{"title":"List warehouse-sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/warehouse-sources","href":"/api-reference/all-endpoints/cdp/list-warehouse-sources"},{"title":"Get one warehouse source connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/warehouse-sources/{connector_id}","href":"/api-reference/all-endpoints/cdp/get-one-warehouse-source-connector"},{"title":"Check a warehouse source connector's activation status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/warehouse-sources/{connector_id}/activation","href":"/api-reference/all-endpoints/cdp/check-a-warehouse-source-connectors-activation-status"},{"title":"Validate a warehouse source connect-form config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/warehouse-sources/{connector_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-a-warehouse-source-connect-form-config"},{"title":"Ingest a CSV/JSON file of events or profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/file-ingest","href":"/api-reference/all-endpoints/cdp/ingest-a-csvjson-file-of-events-or-profiles"},{"title":"List CDP destination connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/destination-catalog","href":"/api-reference/all-endpoints/cdp/list-cdp-destination-connectors"},{"title":"Get a CDP destination connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/destination-catalog/{connector_id}","href":"/api-reference/all-endpoints/cdp/get-a-cdp-destination-connector"},{"title":"Validate a CDP destination connector config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/destination-catalog/{connector_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-a-cdp-destination-connector-config"},{"title":"Get the managed server-side tagging container","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/server-container","href":"/api-reference/all-endpoints/cdp/get-the-managed-server-side-tagging-container"},{"title":"Replace the managed server-side tagging container","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/server-container","href":"/api-reference/all-endpoints/cdp/replace-the-managed-server-side-tagging-container"},{"title":"List BI-tool connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/bi-connectors","href":"/api-reference/all-endpoints/cdp/list-bi-tool-connectors"},{"title":"Get one BI-tool connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/bi-connectors/{tool_id}","href":"/api-reference/all-endpoints/cdp/get-one-bi-tool-connector"},{"title":"Generate a BI connection profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/bi-connectors/{tool_id}/connection-profile","href":"/api-reference/all-endpoints/cdp/generate-a-bi-connection-profile"},{"title":"List enrichment-catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/enrichment-catalog","href":"/api-reference/all-endpoints/cdp/list-enrichment-catalog"},{"title":"Get enrichment-catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/enrichment-catalog/{provider_id}","href":"/api-reference/all-endpoints/cdp/get-enrichment-catalog"},{"title":"Get a provider's account-scoring signals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/enrichment-catalog/{provider_id}/scoring-signals","href":"/api-reference/all-endpoints/cdp/get-a-providers-account-scoring-signals"},{"title":"Validate an enrichment provider config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/validate-config","href":"/api-reference/all-endpoints/cdp/validate-an-enrichment-provider-config"},{"title":"List activation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/enrichment-catalog/{provider_id}/activation","href":"/api-reference/all-endpoints/cdp/list-activation"},{"title":"Create derive","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/derive","href":"/api-reference/all-endpoints/cdp/create-derive"},{"title":"Create broker-preview","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/broker-preview","href":"/api-reference/all-endpoints/cdp/create-broker-preview"},{"title":"Create broker-enrich","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/broker-enrich","href":"/api-reference/all-endpoints/cdp/create-broker-enrich"},{"title":"Enrich one contact from an enrichment provider","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/enrichment/{provider_id}/enrich-contact","href":"/api-reference/all-endpoints/cdp/enrich-one-contact-from-an-enrichment-provider"},{"title":"Clear a contact's enrichment traits","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/enrichment/contacts/{contact_id}","href":"/api-reference/all-endpoints/cdp/clear-a-contacts-enrichment-traits"},{"title":"List the native geo-enrichment signals Orbit reads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/geo-enrichment/sources","href":"/api-reference/all-endpoints/cdp/list-the-native-geo-enrichment-signals-orbit-reads"},{"title":"Preview the native geo-enrichment for a sample payload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/geo-enrichment/preview","href":"/api-reference/all-endpoints/cdp/preview-the-native-geo-enrichment-for-a-sample-payload"},{"title":"List trait-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/trait-governance","href":"/api-reference/all-endpoints/cdp/list-trait-governance"},{"title":"List access","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/trait-governance/access","href":"/api-reference/all-endpoints/cdp/list-access"},{"title":"Get trait-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/trait-governance/{trait_name}","href":"/api-reference/all-endpoints/cdp/get-trait-governance"},{"title":"Update trait-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/trait-governance/{trait_name}","href":"/api-reference/all-endpoints/cdp/update-trait-governance"},{"title":"Delete trait-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/trait-governance/{trait_name}","href":"/api-reference/all-endpoints/cdp/delete-trait-governance"},{"title":"Classify trait-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/trait-governance/classify","href":"/api-reference/all-endpoints/cdp/classify-trait-governance"},{"title":"List event-property-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/event-property-governance","href":"/api-reference/all-endpoints/cdp/list-event-property-governance"},{"title":"Get event-property-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/event-property-governance/{event_name}","href":"/api-reference/all-endpoints/cdp/get-event-property-governance"},{"title":"Update event_name","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/event-property-governance/{event_name}/{property_name}","href":"/api-reference/all-endpoints/cdp/update-event_name"},{"title":"Delete event_name","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/event-property-governance/{event_name}/{property_name}","href":"/api-reference/all-endpoints/cdp/delete-event_name"},{"title":"Classify event-property-governance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/event-property-governance/classify","href":"/api-reference/all-endpoints/cdp/classify-event-property-governance"},{"title":"Get the tenant's effective CDP retention policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/retention-policy","href":"/api-reference/all-endpoints/cdp/get-the-tenants-effective-cdp-retention-policy"},{"title":"Get the effective retention for one target","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/retention-policy/{target}","href":"/api-reference/all-endpoints/cdp/get-the-effective-retention-for-one-target"},{"title":"Update retention-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/retention-policy/{target}","href":"/api-reference/all-endpoints/cdp/update-retention-policy"},{"title":"Remove a retention override","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/retention-policy/{target}","href":"/api-reference/all-endpoints/cdp/remove-a-retention-override"},{"title":"Get PII tokenization policy, registry, and type catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/pii-tokenization","href":"/api-reference/all-endpoints/cdp/get-pii-tokenization-policy-registry-and-type-catalog"},{"title":"Set a PII type's tokenization policy override","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/pii-tokenization/{type}","href":"/api-reference/all-endpoints/cdp/set-a-pii-types-tokenization-policy-override"},{"title":"Remove a PII type's tokenization policy override","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/pii-tokenization/{type}","href":"/api-reference/all-endpoints/cdp/remove-a-pii-types-tokenization-policy-override"},{"title":"Tokenize a batch of sensitive identifiers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/pii-tokenization/tokenize","href":"/api-reference/all-endpoints/cdp/tokenize-a-batch-of-sensitive-identifiers"},{"title":"Detokenize reversible tokens back to cleartext","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/pii-tokenization/detokenize","href":"/api-reference/all-endpoints/cdp/detokenize-reversible-tokens-back-to-cleartext"},{"title":"Read the tenant's survivorship (golden-record) policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/survivorship-policy","href":"/api-reference/all-endpoints/cdp/read-the-tenants-survivorship-golden-record-policy"},{"title":"Replace the tenant's survivorship policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/survivorship-policy","href":"/api-reference/all-endpoints/cdp/replace-the-tenants-survivorship-policy"},{"title":"Clear the tenant's survivorship policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/survivorship-policy","href":"/api-reference/all-endpoints/cdp/clear-the-tenants-survivorship-policy"},{"title":"List computed-trait rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/computed-traits","href":"/api-reference/all-endpoints/cdp/list-computed-trait-rules"},{"title":"Create a computed-trait rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/computed-traits","href":"/api-reference/all-endpoints/cdp/create-a-computed-trait-rule"},{"title":"Update a computed-trait rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/computed-traits/{id}","href":"/api-reference/all-endpoints/cdp/update-a-computed-trait-rule"},{"title":"Delete a computed-trait rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/computed-traits/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-computed-trait-rule"},{"title":"Run a computed-trait rule now","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/computed-traits/{id}/run","href":"/api-reference/all-endpoints/cdp/run-a-computed-trait-rule-now"},{"title":"Preview-evaluate a computed-trait rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/computed-traits/{id}/evaluate","href":"/api-reference/all-endpoints/cdp/preview-evaluate-a-computed-trait-rule"},{"title":"Validate a SQL trait body without persisting","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/sql-traits/validate","href":"/api-reference/all-endpoints/cdp/validate-a-sql-trait-body-without-persisting"},{"title":"List SQL trait definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/sql-traits","href":"/api-reference/all-endpoints/cdp/list-sql-trait-definitions"},{"title":"Create a SQL trait definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/sql-traits","href":"/api-reference/all-endpoints/cdp/create-a-sql-trait-definition"},{"title":"Get one SQL trait definition","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/sql-traits/{id}","href":"/api-reference/all-endpoints/cdp/get-one-sql-trait-definition"},{"title":"Delete a SQL trait definition","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/sql-traits/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-sql-trait-definition"},{"title":"Update a SQL trait definition","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/sql-traits/{id}","href":"/api-reference/all-endpoints/cdp/update-a-sql-trait-definition"},{"title":"Validate warehouse-segments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/warehouse-segments/validate","href":"/api-reference/all-endpoints/cdp/validate-warehouse-segments"},{"title":"List warehouse-segments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/warehouse-segments","href":"/api-reference/all-endpoints/cdp/list-warehouse-segments"},{"title":"Warehouse-segments cdp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/warehouse-segments","href":"/api-reference/all-endpoints/cdp/warehouse-segments-cdp"},{"title":"Get warehouse-segments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/warehouse-segments/{id}","href":"/api-reference/all-endpoints/cdp/get-warehouse-segments"},{"title":"Delete warehouse-segments","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/warehouse-segments/{id}","href":"/api-reference/all-endpoints/cdp/delete-warehouse-segments"},{"title":"Patch warehouse-segments","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/warehouse-segments/{id}","href":"/api-reference/all-endpoints/cdp/patch-warehouse-segments"},{"title":"Read the CDP data graph (entity-relationship metadata)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/data-graph","href":"/api-reference/all-endpoints/cdp/read-the-cdp-data-graph-entity-relationship-metadata"},{"title":"Replace the CDP data graph","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cdp/data-graph","href":"/api-reference/all-endpoints/cdp/replace-the-cdp-data-graph"},{"title":"Validate a linked-audience query against the stored graph without persisting it","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/linked-audiences/validate","href":"/api-reference/all-endpoints/cdp/validate-a-linked-audience-query-against-the-stored-graph-without-persisting-it"},{"title":"List linked audiences","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/linked-audiences","href":"/api-reference/all-endpoints/cdp/list-linked-audiences"},{"title":"Create a linked audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/linked-audiences","href":"/api-reference/all-endpoints/cdp/create-a-linked-audience"},{"title":"Get one linked audience","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/linked-audiences/{id}","href":"/api-reference/all-endpoints/cdp/get-one-linked-audience"},{"title":"Delete a linked audience","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/linked-audiences/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-linked-audience"},{"title":"Partially update a linked audience","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/linked-audiences/{id}","href":"/api-reference/all-endpoints/cdp/partially-update-a-linked-audience"},{"title":"Compile a stored linked audience to its traversal plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/linked-audiences/{id}/compile","href":"/api-reference/all-endpoints/cdp/compile-a-stored-linked-audience-to-its-traversal-plan"},{"title":"Validate a transform spec","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/transform-functions/validate","href":"/api-reference/all-endpoints/cdp/validate-a-transform-spec"},{"title":"List event-transform functions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/transform-functions","href":"/api-reference/all-endpoints/cdp/list-event-transform-functions"},{"title":"Create a transform function","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/transform-functions","href":"/api-reference/all-endpoints/cdp/create-a-transform-function"},{"title":"Get a transform function","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cdp/transform-functions/{id}","href":"/api-reference/all-endpoints/cdp/get-a-transform-function"},{"title":"Delete a transform function","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/cdp/transform-functions/{id}","href":"/api-reference/all-endpoints/cdp/delete-a-transform-function"},{"title":"Update a transform function","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/cdp/transform-functions/{id}","href":"/api-reference/all-endpoints/cdp/update-a-transform-function"},{"title":"Preview a transform on a sample event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cdp/transform-functions/{id}/preview","href":"/api-reference/all-endpoints/cdp/preview-a-transform-on-a-sample-event"}]},{"group":"Health","pages":[{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/health","href":"/api-reference/all-endpoints/health/list-health"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/health","href":"/api-reference/all-endpoints/health/list-health-1"}]},{"group":"Messages","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/sms","href":"/api-reference/all-endpoints/messages/send-an-sms"},{"title":"Send a batch of messages (persist-then-attempt)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/batch","href":"/api-reference/all-endpoints/messages/send-a-batch-of-messages-persist-then-attempt"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/whatsapp","href":"/api-reference/all-endpoints/messages/send-a-whatsapp-message"},{"title":"Send a WhatsApp template to up to 256 recipients (broadcast list)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/whatsapp/broadcast","href":"/api-reference/all-endpoints/messages/send-a-whatsapp-template-to-up-to-256-recipients-broadcast-list"},{"title":"Send a group MMS to up to 20 recipients","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/group","href":"/api-reference/all-endpoints/messages/send-a-group-mms-to-up-to-20-recipients"},{"title":"Convert an image to a carrier-native MMS format (async)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/media/convert","href":"/api-reference/all-endpoints/messages/convert-an-image-to-a-carrier-native-mms-format-async"},{"title":"Poll an MMS media conversion job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/media/convert/{jobId}","href":"/api-reference/all-endpoints/messages/poll-an-mms-media-conversion-job"},{"title":"Check WhatsApp 24h freeform window status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/whatsapp/window-status","href":"/api-reference/all-endpoints/messages/check-whatsapp-24h-freeform-window-status"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/email","href":"/api-reference/all-endpoints/messages/send-an-email"},{"title":"Send an RCS message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/rcs","href":"/api-reference/all-endpoints/messages/send-an-rcs-message"},{"title":"Send a Viber message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/viber","href":"/api-reference/all-endpoints/messages/send-a-viber-message"},{"title":"Send an Instagram DM","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/instagram","href":"/api-reference/all-endpoints/messages/send-an-instagram-dm"},{"title":"Send a Messenger message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/messenger","href":"/api-reference/all-endpoints/messages/send-a-messenger-message"},{"title":"Send a LINE message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/line","href":"/api-reference/all-endpoints/messages/send-a-line-message"},{"title":"Send a Telegram message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/telegram","href":"/api-reference/all-endpoints/messages/send-a-telegram-message"},{"title":"Send a KakaoTalk message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/kakao","href":"/api-reference/all-endpoints/messages/send-a-kakaotalk-message"},{"title":"Send a Zalo message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/zalo","href":"/api-reference/all-endpoints/messages/send-a-zalo-message"},{"title":"Send a WeChat message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/wechat","href":"/api-reference/all-endpoints/messages/send-a-wechat-message"},{"title":"Send a fax","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/fax","href":"/api-reference/all-endpoints/messages/send-a-fax"},{"title":"Export messages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/export","href":"/api-reference/all-endpoints/messages/export-messages"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages","href":"/api-reference/all-endpoints/messages/list-messages"},{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages","href":"/api-reference/all-endpoints/messages/send-a-message"},{"title":"Get messaging settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/settings","href":"/api-reference/all-endpoints/messages/get-messaging-settings"},{"title":"Subscribe to the real-time message event stream (SSE)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/stream","href":"/api-reference/all-endpoints/messages/subscribe-to-the-real-time-message-event-stream-sse"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/{id}","href":"/api-reference/all-endpoints/messages/get-a-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messages/{id}","href":"/api-reference/all-endpoints/messages/delete-a-message"},{"title":"Edit the body and/or scheduled_at of a scheduled message (Twilio Message.update parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messages/{id}","href":"/api-reference/all-endpoints/messages/edit-the-body-andor-scheduled_at-of-a-scheduled-message-twilio-messageupdate-parity"},{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/send","href":"/api-reference/all-endpoints/messages/send-a-message-1"},{"title":"Smart send","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/smart-send","href":"/api-reference/all-endpoints/messages/smart-send"},{"title":"Route preview","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/route-preview","href":"/api-reference/all-endpoints/messages/route-preview"},{"title":"Score artificial-traffic / SMS-pumping risk for a destination","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/risk-signals","href":"/api-reference/all-endpoints/messages/score-artificial-traffic-sms-pumping-risk-for-a-destination"},{"title":"Describe the NCMEC CyberTipline reporting obligation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/media/csam-report/requirements","href":"/api-reference/all-endpoints/messages/describe-the-ncmec-cybertipline-reporting-obligation"},{"title":"Assemble and preserve an NCMEC CyberTipline report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/media/csam-report","href":"/api-reference/all-endpoints/messages/assemble-and-preserve-an-ncmec-cybertipline-report"},{"title":"Read the SMPP bind → Inbox bridge setting","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/smpp-bind-inbox","href":"/api-reference/all-endpoints/messages/read-the-smpp-bind-→-inbox-bridge-setting"},{"title":"Update the SMPP bind → Inbox bridge setting","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/smpp-bind-inbox","href":"/api-reference/all-endpoints/messages/update-the-smpp-bind-→-inbox-bridge-setting"},{"title":"Read the tenant Fraud Shield configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/fraud-shield","href":"/api-reference/all-endpoints/messages/read-the-tenant-fraud-shield-configuration"},{"title":"Update the tenant Fraud Shield configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/fraud-shield","href":"/api-reference/all-endpoints/messages/update-the-tenant-fraud-shield-configuration"},{"title":"Evaluate a destination against the tenant Fraud Shield","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/fraud-shield/evaluate","href":"/api-reference/all-endpoints/messages/evaluate-a-destination-against-the-tenant-fraud-shield"},{"title":"Read the tenant's in-app messages + content cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/in-app","href":"/api-reference/all-endpoints/messages/read-the-tenants-in-app-messages-+-content-cards"},{"title":"Author the tenant's in-app messages + content cards","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/in-app","href":"/api-reference/all-endpoints/messages/author-the-tenants-in-app-messages-+-content-cards"},{"title":"Preview-render a template payload (Twilio Content Preview parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/preview-render","href":"/api-reference/all-endpoints/messages/preview-render-a-template-payload-twilio-content-preview-parity"},{"title":"Lint a draft message (compose-time policy + spam scan)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/lint","href":"/api-reference/all-endpoints/messages/lint-a-draft-message-compose-time-policy-+-spam-scan"},{"title":"Reputation-scan URLs in a draft message (anti-smishing)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/url-scan","href":"/api-reference/all-endpoints/messages/reputation-scan-urls-in-a-draft-message-anti-smishing"},{"title":"Estimate message cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/estimate","href":"/api-reference/all-endpoints/messages/estimate-message-cost"},{"title":"Get message stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/stats","href":"/api-reference/all-endpoints/messages/get-message-stats"},{"title":"Get usage records (Twilio UsageRecord parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/usage/records","href":"/api-reference/all-endpoints/messages/get-usage-records-twilio-usagerecord-parity"},{"title":"Retry a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/retry","href":"/api-reference/all-endpoints/messages/retry-a-message"},{"title":"Re-deliver a message's lifecycle webhook to all endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/replay-webhook","href":"/api-reference/all-endpoints/messages/re-deliver-a-messages-lifecycle-webhook-to-all-endpoints"},{"title":"Cancel a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/cancel","href":"/api-reference/all-endpoints/messages/cancel-a-message"},{"title":"List still-scheduled messages (Twilio scheduled parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/scheduled","href":"/api-reference/all-endpoints/messages/list-still-scheduled-messages-twilio-scheduled-parity"},{"title":"Bulk-cancel still-scheduled messages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/cancel-scheduled","href":"/api-reference/all-endpoints/messages/bulk-cancel-still-scheduled-messages"},{"title":"List media attachments on a message (Twilio Media subresource parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/{id}/media","href":"/api-reference/all-endpoints/messages/list-media-attachments-on-a-message-twilio-media-subresource-parity"},{"title":"Get a per-message route-trace (Infobip/Sinch DLR-opacity closer)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/{id}/trace","href":"/api-reference/all-endpoints/messages/get-a-per-message-route-trace-infobipsinch-dlr-opacity-closer"},{"title":"Get a per-message RCS recipient-engagement timeline (read receipts + taps)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/{id}/rcs-events","href":"/api-reference/all-endpoints/messages/get-a-per-message-rcs-recipient-engagement-timeline-read-receipts-+-taps"},{"title":"Get a per-message proof-of-consent receipt (message→consent-record binding)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/{id}/compliance","href":"/api-reference/all-endpoints/messages/get-a-per-message-proof-of-consent-receipt-message→consent-record-binding"},{"title":"Submit bulk message feedback (Twilio /Messages/Feedback bulk parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/feedback/bulk","href":"/api-reference/all-endpoints/messages/submit-bulk-message-feedback-twilio-messagesfeedback-bulk-parity"},{"title":"Submit message feedback (Twilio Message Feedback parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/feedback","href":"/api-reference/all-endpoints/messages/submit-message-feedback-twilio-message-feedback-parity"},{"title":"Redact a message (GDPR/CCPA PII purge)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/redact","href":"/api-reference/all-endpoints/messages/redact-a-message-gdprccpa-pii-purge"},{"title":"Mark a message as read (cross-device sync)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/{id}/read","href":"/api-reference/all-endpoints/messages/mark-a-message-as-read-cross-device-sync"},{"title":"Bulk-update conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/conversations/bulk","href":"/api-reference/all-endpoints/messages/bulk-update-conversations"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/templates","href":"/api-reference/all-endpoints/messages/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/templates","href":"/api-reference/all-endpoints/messages/create-a-message-template"},{"title":"Per-channel template counts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/templates/summary","href":"/api-reference/all-endpoints/messages/per-channel-template-counts"},{"title":"Get a message template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/templates/{id}","href":"/api-reference/all-endpoints/messages/get-a-message-template"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messages/templates/{id}","href":"/api-reference/all-endpoints/messages/delete-a-message-template"},{"title":"Update a message template","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messages/templates/{id}","href":"/api-reference/all-endpoints/messages/update-a-message-template"},{"title":"Submit a WhatsApp template to Meta for approval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/templates/{id}/submit","href":"/api-reference/all-endpoints/messages/submit-a-whatsapp-template-to-meta-for-approval"},{"title":"Auto-localize a template into multiple locales","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/templates/{id}/localize","href":"/api-reference/all-endpoints/messages/auto-localize-a-template-into-multiple-locales"},{"title":"Get the per-locale approval tracker for a template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/templates/{id}/localizations","href":"/api-reference/all-endpoints/messages/get-the-per-locale-approval-tracker-for-a-template"},{"title":"List content templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/content-templates","href":"/api-reference/all-endpoints/messages/list-content-templates"},{"title":"Create a content template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/content-templates","href":"/api-reference/all-endpoints/messages/create-a-content-template"},{"title":"Get a content template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/content-templates/{id}","href":"/api-reference/all-endpoints/messages/get-a-content-template"},{"title":"Archive a content template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messages/content-templates/{id}","href":"/api-reference/all-endpoints/messages/archive-a-content-template"},{"title":"Update a content template","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messages/content-templates/{id}","href":"/api-reference/all-endpoints/messages/update-a-content-template"},{"title":"Render a content template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/content-templates/{id}/render","href":"/api-reference/all-endpoints/messages/render-a-content-template"},{"title":"List blocked destinations (Bandwidth + Twilio Blocked-Numbers parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/blocklist","href":"/api-reference/all-endpoints/messages/list-blocked-destinations-bandwidth-+-twilio-blocked-numbers-parity"},{"title":"Block a destination from outbound sends (Bandwidth + Twilio Blocked-Numbers parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/blocklist","href":"/api-reference/all-endpoints/messages/block-a-destination-from-outbound-sends-bandwidth-+-twilio-blocked-numbers-parity"},{"title":"Un-block a destination (Bandwidth + Twilio Blocked-Numbers parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messages/blocklist/{id}","href":"/api-reference/all-endpoints/messages/un-block-a-destination-bandwidth-+-twilio-blocked-numbers-parity"},{"title":"List SMS inbound routing rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/inbound-routes","href":"/api-reference/all-endpoints/messages/list-sms-inbound-routing-rules"},{"title":"Create an SMS inbound routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/inbound-routes","href":"/api-reference/all-endpoints/messages/create-an-sms-inbound-routing-rule"},{"title":"Delete an SMS inbound routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messages/inbound-routes/{routeId}","href":"/api-reference/all-endpoints/messages/delete-an-sms-inbound-routing-rule"},{"title":"Patch inbound-routes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messages/inbound-routes/{routeId}","href":"/api-reference/all-endpoints/messages/patch-inbound-routes"},{"title":"Get messaging deliverability metrics + current alert state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/deliverability/alert-status","href":"/api-reference/all-endpoints/messages/get-messaging-deliverability-metrics-+-current-alert-state"},{"title":"Get messaging deliverability alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/deliverability/alert-rules","href":"/api-reference/all-endpoints/messages/get-messaging-deliverability-alert-rules"},{"title":"Set messaging deliverability alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/deliverability/alert-rules","href":"/api-reference/all-endpoints/messages/set-messaging-deliverability-alert-rules"},{"title":"Evaluate messaging deliverability alerts and notify on breach","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/deliverability/alert-check","href":"/api-reference/all-endpoints/messages/evaluate-messaging-deliverability-alerts-and-notify-on-breach"},{"title":"Outbound route-quality scores + DLR latency percentiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/route-quality/scores","href":"/api-reference/all-endpoints/messages/outbound-route-quality-scores-+-dlr-latency-percentiles"},{"title":"Get outbound route-quality thresholds, loopback-probe + circuit-breaker config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/route-quality/settings","href":"/api-reference/all-endpoints/messages/get-outbound-route-quality-thresholds-loopback-probe-+-circuit-breaker-config"},{"title":"Set outbound route-quality thresholds, loopback-probe + circuit-breaker config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/route-quality/settings","href":"/api-reference/all-endpoints/messages/set-outbound-route-quality-thresholds-loopback-probe-+-circuit-breaker-config"},{"title":"Evaluate route-quality alerts and notify on breach","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/route-quality/alert-check","href":"/api-reference/all-endpoints/messages/evaluate-route-quality-alerts-and-notify-on-breach"},{"title":"Advance the carrier-route circuit breaker (auto-suspend + recovery)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/route-quality/circuit-check","href":"/api-reference/all-endpoints/messages/advance-the-carrier-route-circuit-breaker-auto-suspend-+-recovery"},{"title":"Get the org's default cross-channel cascade policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/cascade/policy","href":"/api-reference/all-endpoints/messages/get-the-orgs-default-cross-channel-cascade-policy"},{"title":"Set the org default cross-channel cascade policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messages/cascade/policy","href":"/api-reference/all-endpoints/messages/set-the-org-default-cross-channel-cascade-policy"},{"title":"Resolve one logical cascade group's message legs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/cascade/groups/{groupId}","href":"/api-reference/all-endpoints/messages/resolve-one-logical-cascade-groups-message-legs"},{"title":"Alphanumeric \u0026 international sender-ID warm-up meters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/senders/warmup","href":"/api-reference/all-endpoints/messages/alphanumeric-\u0026-international-sender-id-warm-up-meters"},{"title":"Warm-up meter + ramp forecast for a single sender ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/senders/warmup/lookup","href":"/api-reference/all-endpoints/messages/warm-up-meter-+-ramp-forecast-for-a-single-sender-id"},{"title":"Notify — multi-channel fan-out or waterfall","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/notify","href":"/api-reference/all-endpoints/messages/notify-—-multi-channel-fan-out-or-waterfall"},{"title":"Get a unified notify cascade delivery receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notify/{notifyId}","href":"/api-reference/all-endpoints/messages/get-a-unified-notify-cascade-delivery-receipt"}]},{"group":"Email Builder","pages":[{"title":"Render email template to HTML","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/email-builder/render","href":"/api-reference/all-endpoints/email-builder/render-email-template-to-html"},{"title":"Transpile MJML to HTML email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/email-builder/mjml/render","href":"/api-reference/all-endpoints/email-builder/transpile-mjml-to-html-email"},{"title":"List saved email-builder templates for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messages/email-builder/list","href":"/api-reference/all-endpoints/email-builder/list-saved-email-builder-templates-for-the-tenant"},{"title":"Save email template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/email-builder/save","href":"/api-reference/all-endpoints/email-builder/save-email-template"},{"title":"Send test email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messages/email-builder/send-test","href":"/api-reference/all-endpoints/email-builder/send-test-email"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/templates","href":"/api-reference/all-endpoints/templates/list-templates"},{"title":"Get template cross-campaign analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/templates/{id}/analytics","href":"/api-reference/all-endpoints/templates/get-template-cross-campaign-analytics"}]},{"group":"Agents","pages":[{"title":"Get an agent's full configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}","href":"/api-reference/all-endpoints/agents/get-an-agents-full-configuration"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}","href":"/api-reference/all-endpoints/agents/update-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{id}","href":"/api-reference/all-endpoints/agents/delete-an-agent"},{"title":"Get an agent's voice session configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/voice-config","href":"/api-reference/all-endpoints/agents/get-an-agents-voice-session-configuration"},{"title":"List one agent's conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conversations","href":"/api-reference/all-endpoints/agents/list-one-agents-conversations"},{"title":"Persist one agent conversation (internal callback)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/conversations","href":"/api-reference/all-endpoints/agents/persist-one-agent-conversation-internal-callback"},{"title":"Record a cross-agent handoff","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/internal/handoffs","href":"/api-reference/all-endpoints/agents/record-a-cross-agent-handoff"},{"title":"List an agent's handoff events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/handoffs","href":"/api-reference/all-endpoints/agents/list-an-agents-handoff-events"},{"title":"Look up the squad an agent classifies for","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/squad","href":"/api-reference/all-endpoints/agents/look-up-the-squad-an-agent-classifies-for"},{"title":"Resolve one agent's effective cost cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/cost-cap","href":"/api-reference/all-endpoints/agents/resolve-one-agents-effective-cost-cap"},{"title":"Resolve an agent's primary + fallback model chain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/model-chain","href":"/api-reference/all-endpoints/agents/resolve-an-agents-primary-+-fallback-model-chain"},{"title":"Resolve which model one turn should use","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/model-route","href":"/api-reference/all-endpoints/agents/resolve-which-model-one-turn-should-use"},{"title":"Resolve the agent's budget-driven model downshift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/budget-downshift","href":"/api-reference/all-endpoints/agents/resolve-the-agents-budget-driven-model-downshift"},{"title":"Resolve an agent's token guardrails and effective model","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/token-guardrail","href":"/api-reference/all-endpoints/agents/resolve-an-agents-token-guardrails-and-effective-model"},{"title":"Resolve an agent's speech-to-text failover chain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/stt-chain","href":"/api-reference/all-endpoints/agents/resolve-an-agents-speech-to-text-failover-chain"},{"title":"Resolve agent-as-tool bindings for the runtime","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/agent-tools/resolve","href":"/api-reference/all-endpoints/agents/resolve-agent-as-tool-bindings-for-the-runtime"},{"title":"Read the agent's running A/B experiment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/active-experiment","href":"/api-reference/all-endpoints/agents/read-the-agents-running-ab-experiment"},{"title":"Resolve or persist a sticky A/B variant assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/ab-assignments","href":"/api-reference/all-endpoints/agents/resolve-or-persist-a-sticky-ab-variant-assignment"},{"title":"Record a conversion event on an assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/ab-assignments/{assignmentId}/conversion","href":"/api-reference/all-endpoints/agents/record-a-conversion-event-on-an-assignment"},{"title":"List enabled custom tools for the agent runtime","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/custom-tools/internal/list","href":"/api-reference/all-endpoints/agents/list-enabled-custom-tools-for-the-agent-runtime"},{"title":"Dispatch a custom tool invocation from the agent runtime","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/custom-tools/internal/dispatch","href":"/api-reference/all-endpoints/agents/dispatch-a-custom-tool-invocation-from-the-agent-runtime"},{"title":"List an agent's MCP servers (internal runtime)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/mcp-servers/internal/list","href":"/api-reference/all-endpoints/agents/list-an-agents-mcp-servers-internal-runtime"},{"title":"List active CRM providers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/crm-tools/internal/active-providers","href":"/api-reference/all-endpoints/agents/list-active-crm-providers"},{"title":"Dispatch a CRM tool action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/crm-tools/internal/dispatch","href":"/api-reference/all-endpoints/agents/dispatch-a-crm-tool-action"},{"title":"List an agent's computer-use tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/computer-use-tools/internal/list","href":"/api-reference/all-endpoints/agents/list-an-agents-computer-use-tools"},{"title":"Submit one browser action for a computer-use session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/computer-use-tools/internal/step","href":"/api-reference/all-endpoints/agents/submit-one-browser-action-for-a-computer-use-session"},{"title":"Resolve the governance policy gate for one agent turn","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/governance-internal/resolve","href":"/api-reference/all-endpoints/agents/resolve-the-governance-policy-gate-for-one-agent-turn"},{"title":"List a conversation's stored messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conversations/{conversationId}/messages","href":"/api-reference/all-endpoints/agents/list-a-conversations-stored-messages"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents","href":"/api-reference/all-endpoints/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents","href":"/api-reference/all-endpoints/agents/create-an-agent"},{"title":"List the selectable LLM models","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/models","href":"/api-reference/all-endpoints/agents/list-the-selectable-llm-models"},{"title":"List available agent tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/tools","href":"/api-reference/all-endpoints/agents/list-available-agent-tools"},{"title":"List all agent conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations","href":"/api-reference/all-endpoints/agents/list-all-agent-conversations"},{"title":"List currently live agent conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/live","href":"/api-reference/all-endpoints/agents/list-currently-live-agent-conversations"},{"title":"Get an agent conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}","href":"/api-reference/all-endpoints/agents/get-an-agent-conversation"},{"title":"Analyze a conversation's sentiment and intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/analyze-intelligence","href":"/api-reference/all-endpoints/agents/analyze-a-conversations-sentiment-and-intent"},{"title":"Record a conversation satisfaction rating","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/satisfaction","href":"/api-reference/all-endpoints/agents/record-a-conversation-satisfaction-rating"},{"title":"Fork a conversation into a variant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/fork","href":"/api-reference/all-endpoints/agents/fork-a-conversation-into-a-variant"},{"title":"List a conversation's forked variants","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/variants","href":"/api-reference/all-endpoints/agents/list-a-conversations-forked-variants"},{"title":"Resolve the agent behind a phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/resolve-by-number","href":"/api-reference/all-endpoints/agents/resolve-the-agent-behind-a-phone-number"},{"title":"Get a conversation's debug log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/debug-log","href":"/api-reference/all-endpoints/agents/get-a-conversations-debug-log"},{"title":"Get one conversation turn's debug detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/debug-log/{turnId}","href":"/api-reference/all-endpoints/agents/get-one-conversation-turns-debug-detail"},{"title":"List a conversation's cross-agent handoffs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/handoffs","href":"/api-reference/all-endpoints/agents/list-a-conversations-cross-agent-handoffs"},{"title":"List an agent's recent handoff activity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/handoffs/recent","href":"/api-reference/all-endpoints/agents/list-an-agents-recent-handoff-activity"},{"title":"Escalate a conversation to a human operator","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/escalate","href":"/api-reference/all-endpoints/agents/escalate-a-conversation-to-a-human-operator"},{"title":"Record an agent calendar event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/calendar-events","href":"/api-reference/all-endpoints/agents/record-an-agent-calendar-event"},{"title":"Record a Do-Not-Call suppression from an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/dnc","href":"/api-reference/all-endpoints/agents/record-a-do-not-call-suppression-from-an-agent"},{"title":"Read conversation analytics for an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/analytics","href":"/api-reference/all-endpoints/agents/read-conversation-analytics-for-an-agent"},{"title":"Get an agent's RAG retrieval configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/retrieval-config","href":"/api-reference/all-endpoints/agents/get-an-agents-rag-retrieval-configuration"},{"title":"Update an agent's RAG retrieval configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}/retrieval-config","href":"/api-reference/all-endpoints/agents/update-an-agents-rag-retrieval-configuration"},{"title":"List the agent's agent-as-tool bindings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/agent-tools","href":"/api-reference/all-endpoints/agents/list-the-agents-agent-as-tool-bindings"},{"title":"Replace the agent's agent-as-tool bindings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}/agent-tools","href":"/api-reference/all-endpoints/agents/replace-the-agents-agent-as-tool-bindings"},{"title":"Read first-contact-resolution analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/analytics/fcr","href":"/api-reference/all-endpoints/agents/read-first-contact-resolution-analytics"},{"title":"Export one agent's conversations as CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conversations/export","href":"/api-reference/all-endpoints/agents/export-one-agents-conversations-as-csv"},{"title":"Export one agent's full configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/config/export","href":"/api-reference/all-endpoints/agents/export-one-agents-full-configuration"},{"title":"Create an agent from a portable config document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/config/import","href":"/api-reference/all-endpoints/agents/create-an-agent-from-a-portable-config-document"},{"title":"Create duplicate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/duplicate","href":"/api-reference/all-endpoints/agents/create-duplicate"},{"title":"Deploy one agent to a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/deploy","href":"/api-reference/all-endpoints/agents/deploy-one-agent-to-a-channel"},{"title":"Undeploy an agent from its active channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/undeploy","href":"/api-reference/all-endpoints/agents/undeploy-an-agent-from-its-active-channel"},{"title":"Send a chat message to an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/chat","href":"/api-reference/all-endpoints/agents/send-a-chat-message-to-an-agent"},{"title":"Stream a chat response from an agent (SSE)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/chat/stream","href":"/api-reference/all-endpoints/agents/stream-a-chat-response-from-an-agent-sse"},{"title":"Stream an agent response as SSE word chunks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/stream","href":"/api-reference/all-endpoints/agents/stream-an-agent-response-as-sse-word-chunks"},{"title":"Semantic-search the tenant's knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/kb/query","href":"/api-reference/all-endpoints/agents/semantic-search-the-tenants-knowledge-bases"},{"title":"Search an agent's linked knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/kb-search","href":"/api-reference/all-endpoints/agents/search-an-agents-linked-knowledge-bases"},{"title":"Browse the public agent-template marketplace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/marketplace","href":"/api-reference/all-endpoints/agents/browse-the-public-agent-template-marketplace"},{"title":"Fetch one marketplace template's full detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/marketplace/{slug}","href":"/api-reference/all-endpoints/agents/fetch-one-marketplace-templates-full-detail"},{"title":"Install a marketplace template as a new agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/marketplace/{slug}/install","href":"/api-reference/all-endpoints/agents/install-a-marketplace-template-as-a-new-agent"},{"title":"Submit a template to the marketplace","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/marketplace/publish","href":"/api-reference/all-endpoints/agents/submit-a-template-to-the-marketplace"},{"title":"Review the template moderation queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/marketplace/pending","href":"/api-reference/all-endpoints/agents/review-the-template-moderation-queue"},{"title":"Approve or reject a pending marketplace template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/marketplace/{slug}/moderate","href":"/api-reference/all-endpoints/agents/approve-or-reject-a-pending-marketplace-template"},{"title":"Pull a live marketplace template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/marketplace/{slug}/takedown","href":"/api-reference/all-endpoints/agents/pull-a-live-marketplace-template"},{"title":"List pre-built agent templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/templates","href":"/api-reference/all-endpoints/agents/list-pre-built-agent-templates"},{"title":"Fetch an agent template by id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/templates/{id}","href":"/api-reference/all-endpoints/agents/fetch-an-agent-template-by-id"},{"title":"Instantiate a template as a live agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/templates/{id}/instantiate","href":"/api-reference/all-endpoints/agents/instantiate-a-template-as-a-live-agent"},{"title":"Import a competitor voice assistant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/import","href":"/api-reference/all-endpoints/agents/import-a-competitor-voice-assistant"},{"title":"List the curated voice-agent model presets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/model-presets","href":"/api-reference/all-endpoints/agents/list-the-curated-voice-agent-model-presets"},{"title":"Fetch one curated voice-agent model preset","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/model-presets/{id}","href":"/api-reference/all-endpoints/agents/fetch-one-curated-voice-agent-model-preset"},{"title":"Create a draft agent from a preset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/model-presets/{id}/instantiate","href":"/api-reference/all-endpoints/agents/create-a-draft-agent-from-a-preset"},{"title":"List the shared prompt-template library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/prompt-templates","href":"/api-reference/all-endpoints/agents/list-the-shared-prompt-template-library"},{"title":"Get one prompt template with its version history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/prompt-templates/{id}","href":"/api-reference/all-endpoints/agents/get-one-prompt-template-with-its-version-history"},{"title":"Get one version of a prompt template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/prompt-templates/{id}/versions/{version}","href":"/api-reference/all-endpoints/agents/get-one-version-of-a-prompt-template"},{"title":"Fork a prompt template into a ready-to-use system prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/prompt-templates/{id}/fork","href":"/api-reference/all-endpoints/agents/fork-a-prompt-template-into-a-ready-to-use-system-prompt"},{"title":"Browse one contact's memory on this agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/memory","href":"/api-reference/all-endpoints/agents/browse-one-contacts-memory-on-this-agent"},{"title":"Teach the agent a fact about a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/memory","href":"/api-reference/all-endpoints/agents/teach-the-agent-a-fact-about-a-contact"},{"title":"Forget one memory fact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/memory/{itemId}","href":"/api-reference/all-endpoints/agents/forget-one-memory-fact"},{"title":"List the tenant's agent memory items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/memory","href":"/api-reference/all-endpoints/agents/list-the-tenants-agent-memory-items"},{"title":"Manually teach the agent a memory","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/memory","href":"/api-reference/all-endpoints/agents/manually-teach-the-agent-a-memory"},{"title":"Erase all memory for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/memory","href":"/api-reference/all-endpoints/agents/erase-all-memory-for-a-contact"},{"title":"Fetch a single memory item","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/memory/{id}","href":"/api-reference/all-endpoints/agents/fetch-a-single-memory-item"},{"title":"Delete a single memory item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/memory/{id}","href":"/api-reference/all-endpoints/agents/delete-a-single-memory-item"},{"title":"Boost a memory item's importance","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/memory/{id}","href":"/api-reference/all-endpoints/agents/boost-a-memory-items-importance"},{"title":"List an agent's saved regression tests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/regression-tests","href":"/api-reference/all-endpoints/agents/list-an-agents-saved-regression-tests"},{"title":"Save a regression test for an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/regression-tests","href":"/api-reference/all-endpoints/agents/save-a-regression-test-for-an-agent"},{"title":"Delete a saved regression test","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{id}/regression-tests/{testId}","href":"/api-reference/all-endpoints/agents/delete-a-saved-regression-test"},{"title":"Replay all of an agent's regression tests","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/regression-tests/run-all","href":"/api-reference/all-endpoints/agents/replay-all-of-an-agents-regression-tests"},{"title":"AI-enhance a draft system prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/prompts/enhance","href":"/api-reference/all-endpoints/agents/ai-enhance-a-draft-system-prompt"},{"title":"Create config-assistant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/config-assistant","href":"/api-reference/all-endpoints/agents/create-config-assistant"},{"title":"Run a multi-turn dry-run scenario","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/dry-run","href":"/api-reference/all-endpoints/agents/run-a-multi-turn-dry-run-scenario"},{"title":"Run a pre-deploy batch simulation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/batch-simulation","href":"/api-reference/all-endpoints/agents/run-a-pre-deploy-batch-simulation"},{"title":"Run a live-persona simulation against an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/persona-simulation","href":"/api-reference/all-endpoints/agents/run-a-live-persona-simulation-against-an-agent"},{"title":"Run a pre-launch voice simulation suite","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/voice-simulations","href":"/api-reference/all-endpoints/agents/run-a-pre-launch-voice-simulation-suite"},{"title":"Run a scripted simulation batch with a regression gate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/simulation-eval","href":"/api-reference/all-endpoints/agents/run-a-scripted-simulation-batch-with-a-regression-gate"},{"title":"Run a concurrency-ramp load test on an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/soak-test","href":"/api-reference/all-endpoints/agents/run-a-concurrency-ramp-load-test-on-an-agent"},{"title":"List the adversarial red-team probe catalogue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/red-team/pack","href":"/api-reference/all-endpoints/agents/list-the-adversarial-red-team-probe-catalogue"},{"title":"Run an adversarial red-team safety test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/red-team/run","href":"/api-reference/all-endpoints/agents/run-an-adversarial-red-team-safety-test"},{"title":"List pack","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/fairness-eval/pack","href":"/api-reference/all-endpoints/agents/list-pack"},{"title":"Run fairness-eval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/fairness-eval/run","href":"/api-reference/all-endpoints/agents/run-fairness-eval"},{"title":"List guardrail policy library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/guardrail-policies","href":"/api-reference/all-endpoints/agents/list-guardrail-policy-library"},{"title":"Get a guardrail policy with its safety config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/guardrail-policies/{policyId}","href":"/api-reference/all-endpoints/agents/get-a-guardrail-policy-with-its-safety-config"},{"title":"List guardrail-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/guardrail-policy","href":"/api-reference/all-endpoints/agents/list-guardrail-policy"},{"title":"Apply a guardrail policy to an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/guardrail-policy","href":"/api-reference/all-endpoints/agents/apply-a-guardrail-policy-to-an-agent"},{"title":"Guardrail effectiveness analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/guardrail-analytics","href":"/api-reference/all-endpoints/agents/guardrail-effectiveness-analytics"},{"title":"Audit voice-agent RAG grounding citations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/grounding-citations-audit","href":"/api-reference/all-endpoints/agents/audit-voice-agent-rag-grounding-citations"},{"title":"Issue an agent authorization mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate","href":"/api-reference/all-endpoints/agents/issue-an-agent-authorization-mandate"},{"title":"Dry-run an action against an authorization mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/authorize","href":"/api-reference/all-endpoints/agents/dry-run-an-action-against-an-authorization-mandate"},{"title":"Authorize and commit an action under a mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/act","href":"/api-reference/all-endpoints/agents/authorize-and-commit-an-action-under-a-mandate"},{"title":"Revoke an agent authorization mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/revoke","href":"/api-reference/all-endpoints/agents/revoke-an-agent-authorization-mandate"},{"title":"Verify a mandate's consent-digest integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/verify","href":"/api-reference/all-endpoints/agents/verify-a-mandates-consent-digest-integrity"},{"title":"Delegate a sub-mandate from a parent mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/delegate","href":"/api-reference/all-endpoints/agents/delegate-a-sub-mandate-from-a-parent-mandate"},{"title":"Dry-run a delegated mandate-chain authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/authorize-chain","href":"/api-reference/all-endpoints/agents/dry-run-a-delegated-mandate-chain-authorization"},{"title":"Authorize and commit a delegated action through a mandate chain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/act-chain","href":"/api-reference/all-endpoints/agents/authorize-and-commit-a-delegated-action-through-a-mandate-chain"},{"title":"Audit a mandate delegation chain end-to-end","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/audit-chain","href":"/api-reference/all-endpoints/agents/audit-a-mandate-delegation-chain-end-to-end"},{"title":"Mint a just-in-time agent credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/agent-authorization-mandate/credential","href":"/api-reference/all-endpoints/agents/mint-a-just-in-time-agent-credential"},{"title":"Get one agent's conformity dossier","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conformity-dossier","href":"/api-reference/all-endpoints/agents/get-one-agents-conformity-dossier"},{"title":"Export the signed AI-disclosure provenance ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/ai-disclosure-ledger","href":"/api-reference/all-endpoints/agents/export-the-signed-ai-disclosure-provenance-ledger"},{"title":"Verify a signed AI-disclosure ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/ai-disclosure-ledger/verify","href":"/api-reference/all-endpoints/agents/verify-a-signed-ai-disclosure-ledger"},{"title":"Compare a shadow agent against its production agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/shadow-comparison","href":"/api-reference/all-endpoints/agents/compare-a-shadow-agent-against-its-production-agent"},{"title":"Configure an agent's shadow target","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/shadow","href":"/api-reference/all-endpoints/agents/configure-an-agents-shadow-target"},{"title":"Promote a shadow agent to production","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/shadow/promote","href":"/api-reference/all-endpoints/agents/promote-a-shadow-agent-to-production"},{"title":"List clustered knowledge gaps for a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/knowledge-bases/{id}/gaps","href":"/api-reference/all-endpoints/agents/list-clustered-knowledge-gaps-for-a-knowledge-base"},{"title":"Report questions the agent's knowledge bases could not answer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/kb-unanswered","href":"/api-reference/all-endpoints/agents/report-questions-the-agents-knowledge-bases-could-not-answer"},{"title":"Auto-generate a draft KB answer card from a gap cluster","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/knowledge-bases/{id}/gaps/draft","href":"/api-reference/all-endpoints/agents/auto-generate-a-draft-kb-answer-card-from-a-gap-cluster"},{"title":"Mine automation opportunities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/automation-opportunities","href":"/api-reference/all-endpoints/agents/mine-automation-opportunities"},{"title":"Scaffold a mined automation opportunity into a draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/automation-opportunities/{opportunityId}/scaffold","href":"/api-reference/all-endpoints/agents/scaffold-a-mined-automation-opportunity-into-a-draft"},{"title":"List a knowledge-base document's chunks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/knowledge-base/{docId}/chunks","href":"/api-reference/all-endpoints/agents/list-a-knowledge-base-documents-chunks"},{"title":"Run a similarity search against one document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/knowledge-base/{docId}/test-query","href":"/api-reference/all-endpoints/agents/run-a-similarity-search-against-one-document"},{"title":"Re-run ingest with new chunking parameters","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/knowledge-base/{docId}/rechunk","href":"/api-reference/all-endpoints/agents/re-run-ingest-with-new-chunking-parameters"},{"title":"List an agent's prompt/config version history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/versions","href":"/api-reference/all-endpoints/agents/list-an-agents-promptconfig-version-history"},{"title":"Checkpoint an agent's current config as a version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/versions","href":"/api-reference/all-endpoints/agents/checkpoint-an-agents-current-config-as-a-version"},{"title":"Promote a version to the agent's live config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/versions/{vid}/promote","href":"/api-reference/all-endpoints/agents/promote-a-version-to-the-agents-live-config"},{"title":"Branch an experiment line off a version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/versions/{vid}/branch","href":"/api-reference/all-endpoints/agents/branch-an-experiment-line-off-a-version"},{"title":"Diff an agent version against another version or live state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/versions/{vid}/diff","href":"/api-reference/all-endpoints/agents/diff-an-agent-version-against-another-version-or-live-state"},{"title":"Get an agent's prompt history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/prompt-history","href":"/api-reference/all-endpoints/agents/get-an-agents-prompt-history"},{"title":"Roll back an agent's live prompt to a prior version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/prompt-rollback/{vid}","href":"/api-reference/all-endpoints/agents/roll-back-an-agents-live-prompt-to-a-prior-version"},{"title":"Read the prompt-promotion approval toggle","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/prompt-promotion-approval/settings","href":"/api-reference/all-endpoints/agents/read-the-prompt-promotion-approval-toggle"},{"title":"Set the prompt-promotion approval toggle","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/prompt-promotion-approval/settings","href":"/api-reference/all-endpoints/agents/set-the-prompt-promotion-approval-toggle"},{"title":"Get an agent's pre-promotion regression gate settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/promotion-gate/settings","href":"/api-reference/all-endpoints/agents/get-an-agents-pre-promotion-regression-gate-settings"},{"title":"Set an agent's pre-promotion regression gate settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}/promotion-gate/settings","href":"/api-reference/all-endpoints/agents/set-an-agents-pre-promotion-regression-gate-settings"},{"title":"Get an agent's red-team safety gate settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/red-team/gate-settings","href":"/api-reference/all-endpoints/agents/get-an-agents-red-team-safety-gate-settings"},{"title":"Set an agent's red-team safety gate settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}/red-team/gate-settings","href":"/api-reference/all-endpoints/agents/set-an-agents-red-team-safety-gate-settings"},{"title":"Sweep the tenant for model deprecation advisories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/model-deprecation/advisories","href":"/api-reference/all-endpoints/agents/sweep-the-tenant-for-model-deprecation-advisories"},{"title":"List one agent's model-deprecation advisories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/model-deprecation/advisories","href":"/api-reference/all-endpoints/agents/list-one-agents-model-deprecation-advisories"},{"title":"Evaluate the successor model against the current one","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/model-deprecation/advisories/{modelId}/evaluate-successor","href":"/api-reference/all-endpoints/agents/evaluate-the-successor-model-against-the-current-one"},{"title":"Mint a draft re-pinned to the successor model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/model-deprecation/advisories/{modelId}/repin-draft","href":"/api-reference/all-endpoints/agents/mint-a-draft-re-pinned-to-the-successor-model"},{"title":"Read an agent's newest-first config change trail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/changelog","href":"/api-reference/all-endpoints/agents/read-an-agents-newest-first-config-change-trail"},{"title":"List an agent's conversation quality scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/quality-scores","href":"/api-reference/all-endpoints/agents/list-an-agents-conversation-quality-scores"},{"title":"Get an agent's quality-score trend","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/quality-scores/trend","href":"/api-reference/all-endpoints/agents/get-an-agents-quality-score-trend"},{"title":"Get one agent quality score","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/quality-scores/{scoreId}","href":"/api-reference/all-endpoints/agents/get-one-agent-quality-score"},{"title":"List experiments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/experiments","href":"/api-reference/all-endpoints/agents/list-experiments"},{"title":"Create experiments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/experiments","href":"/api-reference/all-endpoints/agents/create-experiments"},{"title":"Get experiments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/experiments/{expId}","href":"/api-reference/all-endpoints/agents/get-experiments"},{"title":"Compute lift attribution for an A/B experiment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/ab/{expId}/lift","href":"/api-reference/all-endpoints/agents/compute-lift-attribution-for-an-ab-experiment"},{"title":"List results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/experiments/{expId}/results","href":"/api-reference/all-endpoints/agents/list-results"},{"title":"List auto-promotion","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/experiments/{expId}/auto-promotion","href":"/api-reference/all-endpoints/agents/list-auto-promotion"},{"title":"Create end","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/experiments/{expId}/end","href":"/api-reference/all-endpoints/agents/create-end"},{"title":"Create promote-winner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/experiments/{expId}/promote-winner","href":"/api-reference/all-endpoints/agents/create-promote-winner"},{"title":"Propose a prompt fix for an eval regression","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/remediation/propose","href":"/api-reference/all-endpoints/agents/propose-a-prompt-fix-for-an-eval-regression"},{"title":"List custom tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/custom-tools","href":"/api-reference/all-endpoints/agents/list-custom-tools"},{"title":"Register a custom tool","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/custom-tools","href":"/api-reference/all-endpoints/agents/register-a-custom-tool"},{"title":"Get a custom tool","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/custom-tools/{id}","href":"/api-reference/all-endpoints/agents/get-a-custom-tool"},{"title":"Delete a custom tool","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/custom-tools/{id}","href":"/api-reference/all-endpoints/agents/delete-a-custom-tool"},{"title":"Update a custom tool","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/custom-tools/{id}","href":"/api-reference/all-endpoints/agents/update-a-custom-tool"},{"title":"Import custom tools from an OpenAPI spec","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/custom-tools/import","href":"/api-reference/all-endpoints/agents/import-custom-tools-from-an-openapi-spec"},{"title":"Test a custom tool with a sample call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/custom-tools/{id}/test","href":"/api-reference/all-endpoints/agents/test-a-custom-tool-with-a-sample-call"},{"title":"List an agent's computer-use tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/computer-use-tools","href":"/api-reference/all-endpoints/agents/list-an-agents-computer-use-tools-1"},{"title":"Create a computer-use tool","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/computer-use-tools","href":"/api-reference/all-endpoints/agents/create-a-computer-use-tool"},{"title":"Delete a computer-use tool","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/computer-use-tools/{toolId}","href":"/api-reference/all-endpoints/agents/delete-a-computer-use-tool"},{"title":"Update a computer-use tool","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/computer-use-tools/{toolId}","href":"/api-reference/all-endpoints/agents/update-a-computer-use-tool"},{"title":"Dry-run one computer-use browser action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/computer-use-tools/{toolId}/dry-run","href":"/api-reference/all-endpoints/agents/dry-run-one-computer-use-browser-action"},{"title":"List an agent's computer-use sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/computer-use/sessions","href":"/api-reference/all-endpoints/agents/list-an-agents-computer-use-sessions"},{"title":"Get one computer-use session's action trace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/computer-use/sessions/{sessionId}","href":"/api-reference/all-endpoints/agents/get-one-computer-use-sessions-action-trace"},{"title":"Get an agent's invocation rate limits and live usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/rate-limits","href":"/api-reference/all-endpoints/agents/get-an-agents-invocation-rate-limits-and-live-usage"},{"title":"Set an agent's invocation rate limits","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{id}/rate-limits","href":"/api-reference/all-endpoints/agents/set-an-agents-invocation-rate-limits"},{"title":"Get the org's BYO LLM inference credential config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/llm-provider-credential","href":"/api-reference/all-endpoints/agents/get-the-orgs-byo-llm-inference-credential-config"},{"title":"Register a BYO LLM inference credential","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/llm-provider-credential","href":"/api-reference/all-endpoints/agents/register-a-byo-llm-inference-credential"},{"title":"Activate a pending BYO LLM inference credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/llm-provider-credential/activate","href":"/api-reference/all-endpoints/agents/activate-a-pending-byo-llm-inference-credential"},{"title":"Toggle automatic fallback to Orbit's pooled model","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/llm-provider-credential/pooled-fallback","href":"/api-reference/all-endpoints/agents/toggle-automatic-fallback-to-orbits-pooled-model"},{"title":"Rotate the BYO LLM inference credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/llm-provider-credential/rotate","href":"/api-reference/all-endpoints/agents/rotate-the-byo-llm-inference-credential"},{"title":"Revoke the BYO LLM inference credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/llm-provider-credential/revoke","href":"/api-reference/all-endpoints/agents/revoke-the-byo-llm-inference-credential"},{"title":"List an agent's placed outbound calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/calls","href":"/api-reference/all-endpoints/agents/list-an-agents-placed-outbound-calls"},{"title":"Originate an outbound call from a voice agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/calls","href":"/api-reference/all-endpoints/agents/originate-an-outbound-call-from-a-voice-agent"},{"title":"Get an agent's outbound-calling settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/outbound-calling","href":"/api-reference/all-endpoints/agents/get-an-agents-outbound-calling-settings"},{"title":"Update an agent's outbound-calling settings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{id}/outbound-calling","href":"/api-reference/all-endpoints/agents/update-an-agents-outbound-calling-settings"},{"title":"List an agent's registered MCP servers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/mcp-servers","href":"/api-reference/all-endpoints/agents/list-an-agents-registered-mcp-servers"},{"title":"Register an MCP server for the agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/mcp-servers","href":"/api-reference/all-endpoints/agents/register-an-mcp-server-for-the-agent"},{"title":"Remove a registered MCP server","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/mcp-servers/{id}","href":"/api-reference/all-endpoints/agents/remove-a-registered-mcp-server"},{"title":"Update an MCP server's governance flags","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/mcp-servers/{id}","href":"/api-reference/all-endpoints/agents/update-an-mcp-servers-governance-flags"},{"title":"Pre-save connectivity probe for a candidate server","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/mcp-servers/probe","href":"/api-reference/all-endpoints/agents/pre-save-connectivity-probe-for-a-candidate-server"},{"title":"Post-save health check on a registered server","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/mcp-servers/{id}/test","href":"/api-reference/all-endpoints/agents/post-save-health-check-on-a-registered-server"},{"title":"List an agent's eval datasets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/datasets","href":"/api-reference/all-endpoints/agents/list-an-agents-eval-datasets"},{"title":"Create an eval dataset with inline rows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/evals/datasets","href":"/api-reference/all-endpoints/agents/create-an-eval-dataset-with-inline-rows"},{"title":"Promote a conversation trace into an eval dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/evals/datasets/from-conversation","href":"/api-reference/all-endpoints/agents/promote-a-conversation-trace-into-an-eval-dataset"},{"title":"Get one eval dataset with all its rows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/datasets/{dsId}","href":"/api-reference/all-endpoints/agents/get-one-eval-dataset-with-all-its-rows"},{"title":"Delete an eval dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/evals/datasets/{dsId}","href":"/api-reference/all-endpoints/agents/delete-an-eval-dataset"},{"title":"Update an eval dataset's name or description","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/evals/datasets/{dsId}","href":"/api-reference/all-endpoints/agents/update-an-eval-datasets-name-or-description"},{"title":"Delete one eval dataset row","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/evals/datasets/{dsId}/rows/{rowId}","href":"/api-reference/all-endpoints/agents/delete-one-eval-dataset-row"},{"title":"Update one eval dataset row","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/evals/datasets/{dsId}/rows/{rowId}","href":"/api-reference/all-endpoints/agents/update-one-eval-dataset-row"},{"title":"List an agent's eval runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/runs","href":"/api-reference/all-endpoints/agents/list-an-agents-eval-runs"},{"title":"Start an eval run against a dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/evals/runs","href":"/api-reference/all-endpoints/agents/start-an-eval-run-against-a-dataset"},{"title":"Get one eval run with per-row results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/runs/{runId}","href":"/api-reference/all-endpoints/agents/get-one-eval-run-with-per-row-results"},{"title":"Export an eval run as a fine-tuning JSONL dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/runs/{runId}/export","href":"/api-reference/all-endpoints/agents/export-an-eval-run-as-a-fine-tuning-jsonl-dataset"},{"title":"Compare two eval runs side by side","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/evals/runs/compare","href":"/api-reference/all-endpoints/agents/compare-two-eval-runs-side-by-side"},{"title":"Submit an async batch inference job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/batch","href":"/api-reference/all-endpoints/agents/submit-an-async-batch-inference-job"},{"title":"Poll a batch inference job's status and results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/batch/{batchId}","href":"/api-reference/all-endpoints/agents/poll-a-batch-inference-jobs-status-and-results"},{"title":"List the tool approval queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/tool-approvals","href":"/api-reference/all-endpoints/agents/list-the-tool-approval-queue"},{"title":"Approve a pending tool call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/tool-approvals/{id}/approve","href":"/api-reference/all-endpoints/agents/approve-a-pending-tool-call"},{"title":"Reject a pending tool call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/tool-approvals/{id}/reject","href":"/api-reference/all-endpoints/agents/reject-a-pending-tool-call"},{"title":"List a conversation's supervisor notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/supervisor-notes","href":"/api-reference/all-endpoints/agents/list-a-conversations-supervisor-notes"},{"title":"Send a supervisor note to a live conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/supervisor-notes","href":"/api-reference/all-endpoints/agents/send-a-supervisor-note-to-a-live-conversation"},{"title":"Watch every live agent conversation in one feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/oversight/sessions","href":"/api-reference/all-endpoints/agents/watch-every-live-agent-conversation-in-one-feed"},{"title":"Read one live session's oversight detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/oversight/sessions/{conversationId}","href":"/api-reference/all-endpoints/agents/read-one-live-sessions-oversight-detail"},{"title":"Take over a live AI conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/oversight/sessions/{conversationId}/takeover","href":"/api-reference/all-endpoints/agents/take-over-a-live-ai-conversation"},{"title":"Hand a taken-over conversation back to the AI","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/oversight/sessions/{conversationId}/release","href":"/api-reference/all-endpoints/agents/hand-a-taken-over-conversation-back-to-the-ai"},{"title":"Audit ambient-agent proactive outreach","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/ambient-outreach/audit","href":"/api-reference/all-endpoints/agents/audit-ambient-agent-proactive-outreach"},{"title":"List an agent's outcome rubrics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/outcomes/rubrics","href":"/api-reference/all-endpoints/agents/list-an-agents-outcome-rubrics"},{"title":"Create an outcome-scoring rubric","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/outcomes/rubrics","href":"/api-reference/all-endpoints/agents/create-an-outcome-scoring-rubric"},{"title":"Delete an outcome rubric","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/outcomes/rubrics/{rubricId}","href":"/api-reference/all-endpoints/agents/delete-an-outcome-rubric"},{"title":"Update an outcome rubric","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/outcomes/rubrics/{rubricId}","href":"/api-reference/all-endpoints/agents/update-an-outcome-rubric"},{"title":"Read per-rubric pass-rate stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/outcomes/stats","href":"/api-reference/all-endpoints/agents/read-per-rubric-pass-rate-stats"},{"title":"Read outcome value vs cost (P\u0026L)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/outcomes/pnl","href":"/api-reference/all-endpoints/agents/read-outcome-value-vs-cost-p\u0026l"},{"title":"List a conversation's outcome-scoring results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/outcomes","href":"/api-reference/all-endpoints/agents/list-a-conversations-outcome-scoring-results"},{"title":"List org-scoped outcome rubrics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/outcomes/rubrics","href":"/api-reference/all-endpoints/agents/list-org-scoped-outcome-rubrics"},{"title":"Create an org-scoped outcome rubric","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/outcomes/rubrics","href":"/api-reference/all-endpoints/agents/create-an-org-scoped-outcome-rubric"},{"title":"Delete an outcome rubric by id","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/outcomes/rubrics/{rubricId}","href":"/api-reference/all-endpoints/agents/delete-an-outcome-rubric-by-id"},{"title":"Update an outcome rubric by id","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/outcomes/rubrics/{rubricId}","href":"/api-reference/all-endpoints/agents/update-an-outcome-rubric-by-id"},{"title":"Compare an agent's quality over two windows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/quality-scorecard","href":"/api-reference/all-endpoints/agents/compare-an-agents-quality-over-two-windows"},{"title":"Read an agent's persisted canary rollout state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/canary-rollout","href":"/api-reference/all-endpoints/agents/read-an-agents-persisted-canary-rollout-state"},{"title":"Start a canary rollout for a candidate version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/canary-rollout","href":"/api-reference/all-endpoints/agents/start-a-canary-rollout-for-a-candidate-version"},{"title":"Evaluate and advance (or hold/rollback/complete) the canary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/canary-rollout/evaluate","href":"/api-reference/all-endpoints/agents/evaluate-and-advance-or-holdrollbackcomplete-the-canary"},{"title":"Operator kill-switch — pull the canary candidate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/canary-rollout/rollback","href":"/api-reference/all-endpoints/agents/operator-kill-switch-—-pull-the-canary-candidate"},{"title":"Cancel an agent's active canary rollout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/canary-rollout/cancel","href":"/api-reference/all-endpoints/agents/cancel-an-agents-active-canary-rollout"},{"title":"Read an agent's retrieval-benchmark history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/retrieval-benchmark","href":"/api-reference/all-endpoints/agents/read-an-agents-retrieval-benchmark-history"},{"title":"Score and persist a retrieval-benchmark run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/retrieval-benchmark/runs","href":"/api-reference/all-endpoints/agents/score-and-persist-a-retrieval-benchmark-run"},{"title":"Pin a run as the retrieval regression-gate baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/retrieval-benchmark/baseline","href":"/api-reference/all-endpoints/agents/pin-a-run-as-the-retrieval-regression-gate-baseline"},{"title":"Read an agent's operational KPI snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/operational-kpis","href":"/api-reference/all-endpoints/agents/read-an-agents-operational-kpi-snapshot"},{"title":"Read an agent's KPI alert thresholds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/operational-kpis/alert-rules","href":"/api-reference/all-endpoints/agents/read-an-agents-kpi-alert-thresholds"},{"title":"Replace an agent's KPI alert thresholds","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{agentId}/operational-kpis/alert-rules","href":"/api-reference/all-endpoints/agents/replace-an-agents-kpi-alert-thresholds"},{"title":"Evaluate current KPIs and page on breach","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/operational-kpis/alert-check","href":"/api-reference/all-endpoints/agents/evaluate-current-kpis-and-page-on-breach"},{"title":"Read tenant-wide agent hub KPIs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/stats","href":"/api-reference/all-endpoints/agents/read-tenant-wide-agent-hub-kpis"},{"title":"List an agent's custom outcome metric definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/custom-outcome-metrics","href":"/api-reference/all-endpoints/agents/list-an-agents-custom-outcome-metric-definitions"},{"title":"Replace an agent's custom metric definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{agentId}/custom-outcome-metrics","href":"/api-reference/all-endpoints/agents/replace-an-agents-custom-metric-definitions"},{"title":"Record one occurrence of a custom metric","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/custom-outcome-metrics/{metricKey}/record","href":"/api-reference/all-endpoints/agents/record-one-occurrence-of-a-custom-metric"},{"title":"Get one custom metric's analytics rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/custom-outcome-metrics/{metricKey}/analytics","href":"/api-reference/all-endpoints/agents/get-one-custom-metrics-analytics-rollup"},{"title":"Read one agent's grounding monitor","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/grounding","href":"/api-reference/all-endpoints/agents/read-one-agents-grounding-monitor"},{"title":"Read one agent's grounding alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/grounding/alert-rules","href":"/api-reference/all-endpoints/agents/read-one-agents-grounding-alert-rules"},{"title":"Replace one agent's grounding alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/{agentId}/grounding/alert-rules","href":"/api-reference/all-endpoints/agents/replace-one-agents-grounding-alert-rules"},{"title":"Evaluate grounding and notify on breaches","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/grounding/alert-check","href":"/api-reference/all-endpoints/agents/evaluate-grounding-and-notify-on-breaches"},{"title":"List an agent's recent tool calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/tool-history","href":"/api-reference/all-endpoints/agents/list-an-agents-recent-tool-calls"},{"title":"Get a conversation's AI-turn audit log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/conversations/{conversationId}/ai-turn-audit","href":"/api-reference/all-endpoints/agents/get-a-conversations-ai-turn-audit-log"},{"title":"Export the AI-turn audit log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/ai-turn-audit","href":"/api-reference/all-endpoints/agents/export-the-ai-turn-audit-log"},{"title":"Record a human override on an AI turn","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/ai-turn-audit/{auditId}/override","href":"/api-reference/all-endpoints/agents/record-a-human-override-on-an-ai-turn"},{"title":"List citations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/grounding/citations","href":"/api-reference/all-endpoints/agents/list-citations"},{"title":"Read one conversation's execution trace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conversations/{conversationId}/execution-trace","href":"/api-reference/all-endpoints/agents/read-one-conversations-execution-trace"},{"title":"Export one conversation's execution trace (OTLP / Langfuse)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/conversations/{conversationId}/execution-trace/export","href":"/api-reference/all-endpoints/agents/export-one-conversations-execution-trace-otlp-langfuse"},{"title":"Push one conversation's execution trace to a collector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/conversations/{conversationId}/execution-trace/push","href":"/api-reference/all-endpoints/agents/push-one-conversations-execution-trace-to-a-collector"},{"title":"Get the org's live execution-trace push target","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/trace-push-target","href":"/api-reference/all-endpoints/agents/get-the-orgs-live-execution-trace-push-target"},{"title":"Configure the live execution-trace push target","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/trace-push-target","href":"/api-reference/all-endpoints/agents/configure-the-live-execution-trace-push-target"},{"title":"Remove the live execution-trace push target","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/trace-push-target","href":"/api-reference/all-endpoints/agents/remove-the-live-execution-trace-push-target"},{"title":"Ranked review candidates for labeling","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/labeling/queue","href":"/api-reference/all-endpoints/agents/ranked-review-candidates-for-labeling"},{"title":"List an agent's submitted labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/labeling/annotations","href":"/api-reference/all-endpoints/agents/list-an-agents-submitted-labels"},{"title":"Submit a human label for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/labeling/annotations","href":"/api-reference/all-endpoints/agents/submit-a-human-label-for-a-conversation"},{"title":"List fine-tuning jobs and registered models","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/fine-tuning/jobs","href":"/api-reference/all-endpoints/agents/list-fine-tuning-jobs-and-registered-models"},{"title":"Create a managed fine-tuning job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/fine-tuning/jobs","href":"/api-reference/all-endpoints/agents/create-a-managed-fine-tuning-job"},{"title":"Advance a fine-tuning job's lifecycle","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}","href":"/api-reference/all-endpoints/agents/advance-a-fine-tuning-jobs-lifecycle"},{"title":"Deploy a registered custom model to the agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/fine-tuning/models/{modelId}/deploy","href":"/api-reference/all-endpoints/agents/deploy-a-registered-custom-model-to-the-agent"},{"title":"Undeploy the agent's active custom model","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{agentId}/fine-tuning/models/{modelId}/deploy","href":"/api-reference/all-endpoints/agents/undeploy-the-agents-active-custom-model"},{"title":"Evaluate a conversation for an agent loop","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/conversations/{conversationId}/loop-check","href":"/api-reference/all-endpoints/agents/evaluate-a-conversation-for-an-agent-loop"},{"title":"List voice-eval golden sets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/golden-sets","href":"/api-reference/all-endpoints/agents/list-voice-eval-golden-sets"},{"title":"Create a voice-eval golden set","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/voice-eval/golden-sets","href":"/api-reference/all-endpoints/agents/create-a-voice-eval-golden-set"},{"title":"Get a voice-eval golden set","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/golden-sets/{id}","href":"/api-reference/all-endpoints/agents/get-a-voice-eval-golden-set"},{"title":"List voice-eval runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/runs","href":"/api-reference/all-endpoints/agents/list-voice-eval-runs"},{"title":"Trigger a voice-eval run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/voice-eval/runs","href":"/api-reference/all-endpoints/agents/trigger-a-voice-eval-run"},{"title":"Get a voice-eval run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/runs/{id}","href":"/api-reference/all-endpoints/agents/get-a-voice-eval-run"},{"title":"Compare a run to its baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/runs/{id}/regression-delta","href":"/api-reference/all-endpoints/agents/compare-a-run-to-its-baseline"},{"title":"Get the production-call eval sampling policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/voice-eval/sampling-policy","href":"/api-reference/all-endpoints/agents/get-the-production-call-eval-sampling-policy"},{"title":"Update the production-call eval sampling policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/voice-eval/sampling-policy","href":"/api-reference/all-endpoints/agents/update-the-production-call-eval-sampling-policy"},{"title":"Run a golden-set eval suite and score regressions in one batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/voice-eval/suites/run","href":"/api-reference/all-endpoints/agents/run-a-golden-set-eval-suite-and-score-regressions-in-one-batch"},{"title":"List agent governance policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/governance/policies","href":"/api-reference/all-endpoints/agents/list-agent-governance-policies"},{"title":"Create an agent governance policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/governance/policies","href":"/api-reference/all-endpoints/agents/create-an-agent-governance-policy"},{"title":"Get a governance policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/governance/policies/{policyId}","href":"/api-reference/all-endpoints/agents/get-a-governance-policy"},{"title":"Delete a governance policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/governance/policies/{policyId}","href":"/api-reference/all-endpoints/agents/delete-a-governance-policy"},{"title":"Update a governance policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/governance/policies/{policyId}","href":"/api-reference/all-endpoints/agents/update-a-governance-policy"},{"title":"List an agent's studio graphs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/studio/graphs","href":"/api-reference/all-endpoints/agents/list-an-agents-studio-graphs"},{"title":"Save a studio graph as a draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/studio/graphs","href":"/api-reference/all-endpoints/agents/save-a-studio-graph-as-a-draft"},{"title":"Fetch one studio graph with its canvas payload","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/studio/graphs/{graphId}","href":"/api-reference/all-endpoints/agents/fetch-one-studio-graph-with-its-canvas-payload"},{"title":"Stage a draft studio graph","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/studio/graphs/{graphId}/stage","href":"/api-reference/all-endpoints/agents/stage-a-draft-studio-graph"},{"title":"Publish a staged studio graph","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/studio/graphs/{graphId}/publish","href":"/api-reference/all-endpoints/agents/publish-a-staged-studio-graph"},{"title":"Inspect a studio graph run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{agentId}/studio/graphs/{graphId}/runs/{runId}","href":"/api-reference/all-endpoints/agents/inspect-a-studio-graph-run"},{"title":"Dry-run a studio graph with one message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{agentId}/studio/graphs/{graphId}/test-run","href":"/api-reference/all-endpoints/agents/dry-run-a-studio-graph-with-one-message"},{"title":"List agent squads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/squads","href":"/api-reference/all-endpoints/agents/list-agent-squads"},{"title":"Create an agent squad","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/squads","href":"/api-reference/all-endpoints/agents/create-an-agent-squad"},{"title":"Get an agent squad","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/squads/{id}","href":"/api-reference/all-endpoints/agents/get-an-agent-squad"},{"title":"Update an agent squad","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/agents/squads/{id}","href":"/api-reference/all-endpoints/agents/update-an-agent-squad"},{"title":"Delete an agent squad","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/squads/{id}","href":"/api-reference/all-endpoints/agents/delete-an-agent-squad"},{"title":"Simulate squad classifier routing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/squads/{id}/test","href":"/api-reference/all-endpoints/agents/simulate-squad-classifier-routing"},{"title":"Read a squad's orchestration analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/squads/{id}/analytics","href":"/api-reference/all-endpoints/agents/read-a-squads-orchestration-analytics"},{"title":"Generate a draft agent from plain English","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/from-prompt","href":"/api-reference/all-endpoints/agents/generate-a-draft-agent-from-plain-english"},{"title":"Generate a draft agent as a live event stream","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/from-prompt/stream","href":"/api-reference/all-endpoints/agents/generate-a-draft-agent-as-a-live-event-stream"},{"title":"Activate a generated draft agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/from-prompt/{draftId}/activate","href":"/api-reference/all-endpoints/agents/activate-a-generated-draft-agent"},{"title":"Get a draft agent's seeded example inputs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/from-prompt/{draftId}/sandbox-test","href":"/api-reference/all-endpoints/agents/get-a-draft-agents-seeded-example-inputs"},{"title":"Get an agent's public A2A Agent Card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/.well-known/agent-card.json","href":"/api-reference/all-endpoints/agents/get-an-agents-public-a2a-agent-card"},{"title":"Get an agent's public A2A Agent Card (legacy path)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/.well-known/agent.json","href":"/api-reference/all-endpoints/agents/get-an-agents-public-a2a-agent-card-legacy-path"},{"title":"Get an agent's public AGNTCY OASF record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/.well-known/oasf-record.json","href":"/api-reference/all-endpoints/agents/get-an-agents-public-agntcy-oasf-record"},{"title":"Invoke an agent over the A2A JSON-RPC endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/a2a","href":"/api-reference/all-endpoints/agents/invoke-an-agent-over-the-a2a-json-rpc-endpoint"},{"title":"List an agent's A2A tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/a2a/tasks","href":"/api-reference/all-endpoints/agents/list-an-agents-a2a-tasks"},{"title":"Create an inbound A2A task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/a2a/tasks","href":"/api-reference/all-endpoints/agents/create-an-inbound-a2a-task"},{"title":"Get an A2A task by id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/a2a/tasks/{taskId}","href":"/api-reference/all-endpoints/agents/get-an-a2a-task-by-id"},{"title":"Advance an A2A task's lifecycle status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/agents/{id}/a2a/tasks/{taskId}","href":"/api-reference/all-endpoints/agents/advance-an-a2a-tasks-lifecycle-status"},{"title":"Get an agent's A2A card and shareable endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/a2a/card","href":"/api-reference/all-endpoints/agents/get-an-agents-a2a-card-and-shareable-endpoint"},{"title":"Delegate a task to a remote A2A peer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/a2a/tasks/outbound","href":"/api-reference/all-endpoints/agents/delegate-a-task-to-a-remote-a2a-peer"},{"title":"List an agent's A2A peers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/a2a/peers","href":"/api-reference/all-endpoints/agents/list-an-agents-a2a-peers"},{"title":"Add an A2A peer to an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/agents/{id}/a2a/peers","href":"/api-reference/all-endpoints/agents/add-an-a2a-peer-to-an-agent"},{"title":"Remove an A2A peer from an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/agents/{id}/a2a/peers/{peerId}","href":"/api-reference/all-endpoints/agents/remove-an-a2a-peer-from-an-agent"},{"title":"Get an agent's performance scorecard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/agents/{id}/scorecard","href":"/api-reference/all-endpoints/agents/get-an-agents-performance-scorecard"},{"title":"Get Orbit's agent identity-token JWKS","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/.well-known/jwks.json","href":"/api-reference/all-endpoints/agents/get-orbits-agent-identity-token-jwks"},{"title":"Get Orbit's agent public-key directory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/.well-known/http-message-signatures-directory","href":"/api-reference/all-endpoints/agents/get-orbits-agent-public-key-directory"},{"title":"Agent Name Service (ANS) Trust Card (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/.well-known/ans/trust-card.json","href":"/api-reference/all-endpoints/agents/agent-name-service-ans-trust-card-public"},{"title":"Public ANS Agent Trust Registry lookup (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/.well-known/ans/registry/lookup","href":"/api-reference/all-endpoints/agents/public-ans-agent-trust-registry-lookup-public"}]},{"group":"Numbers","pages":[{"title":"List numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers","href":"/api-reference/all-endpoints/numbers/list-numbers"},{"title":"Export the number inventory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/export","href":"/api-reference/all-endpoints/numbers/export-the-number-inventory"},{"title":"List countries with available number inventory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/available/countries","href":"/api-reference/all-endpoints/numbers/list-countries-with-available-number-inventory"},{"title":"Search available numbers to buy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/available","href":"/api-reference/all-endpoints/numbers/search-available-numbers-to-buy"},{"title":"List block","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/available/block","href":"/api-reference/all-endpoints/numbers/list-block"},{"title":"Per-country capability + stock summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/country-capabilities","href":"/api-reference/all-endpoints/numbers/per-country-capability-+-stock-summary"},{"title":"Pre-purchase regulatory preview for one country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/regulatory-preview","href":"/api-reference/all-endpoints/numbers/pre-purchase-regulatory-preview-for-one-country"},{"title":"Discover pre-purchase regulatory requirements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/regulatory-requirements","href":"/api-reference/all-endpoints/numbers/discover-pre-purchase-regulatory-requirements"},{"title":"List regulatory bundles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/regulatory-bundles","href":"/api-reference/all-endpoints/numbers/list-regulatory-bundles"},{"title":"List low-stock inventory alerts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/inventory-alerts","href":"/api-reference/all-endpoints/numbers/list-low-stock-inventory-alerts"},{"title":"Get number cost analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/cost-analytics","href":"/api-reference/all-endpoints/numbers/get-number-cost-analytics"},{"title":"List dormant DID release candidates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/dormancy-alerts","href":"/api-reference/all-endpoints/numbers/list-dormant-did-release-candidates"},{"title":"List numbers with expiring regulatory documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/document-expiry-alerts","href":"/api-reference/all-endpoints/numbers/list-numbers-with-expiring-regulatory-documents"},{"title":"List carrier reputation alerts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/reputation-alerts","href":"/api-reference/all-endpoints/numbers/list-carrier-reputation-alerts"},{"title":"List numbers about to lapse with auto-renew off","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/renewal-expiry-alerts","href":"/api-reference/all-endpoints/numbers/list-numbers-about-to-lapse-with-auto-renew-off"},{"title":"List inbound reverse-map gaps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/inbound-reverse-map-gap","href":"/api-reference/all-endpoints/numbers/list-inbound-reverse-map-gaps"},{"title":"STIR/SHAKEN attestation analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/attestation-analytics","href":"/api-reference/all-endpoints/numbers/stirshaken-attestation-analytics"},{"title":"Inbound STIR/SHAKEN attestation analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/inbound-attestation-analytics","href":"/api-reference/all-endpoints/numbers/inbound-stirshaken-attestation-analytics"},{"title":"Get the organization's active trial number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/trial","href":"/api-reference/all-endpoints/numbers/get-the-organizations-active-trial-number"},{"title":"Claim-trial numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/claim-trial","href":"/api-reference/all-endpoints/numbers/claim-trial-numbers"},{"title":"Release the trial number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/release-trial","href":"/api-reference/all-endpoints/numbers/release-the-trial-number"},{"title":"Purchase the trial number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/purchase-trial","href":"/api-reference/all-endpoints/numbers/purchase-the-trial-number"},{"title":"List recoverable (snapback) numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/recoverable","href":"/api-reference/all-endpoints/numbers/list-recoverable-snapback-numbers"},{"title":"List number orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/orders","href":"/api-reference/all-endpoints/numbers/list-number-orders"},{"title":"Get a number order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/orders/{id}","href":"/api-reference/all-endpoints/numbers/get-a-number-order"},{"title":"Get numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}","href":"/api-reference/all-endpoints/numbers/get-numbers"},{"title":"Update numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}","href":"/api-reference/all-endpoints/numbers/update-numbers"},{"title":"Delete numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}","href":"/api-reference/all-endpoints/numbers/delete-numbers"},{"title":"Purchase a phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/purchase","href":"/api-reference/all-endpoints/numbers/purchase-a-phone-number"},{"title":"Buy-bulk numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/buy-bulk","href":"/api-reference/all-endpoints/numbers/buy-bulk-numbers"},{"title":"Buy-block numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/buy-block","href":"/api-reference/all-endpoints/numbers/buy-block-numbers"},{"title":"Release-bulk numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/release-bulk","href":"/api-reference/all-endpoints/numbers/release-bulk-numbers"},{"title":"Bulk-update numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/bulk-update","href":"/api-reference/all-endpoints/numbers/bulk-update-numbers"},{"title":"Bulk routing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/routing/bulk","href":"/api-reference/all-endpoints/numbers/bulk-routing"},{"title":"Bulk-reserve numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/bulk-reserve","href":"/api-reference/all-endpoints/numbers/bulk-reserve-numbers"},{"title":"Get bulk-reserve","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/bulk-reserve/{id}","href":"/api-reference/all-endpoints/numbers/get-bulk-reserve"},{"title":"Create finalize","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/bulk-reserve/{id}/finalize","href":"/api-reference/all-endpoints/numbers/create-finalize"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/bulk-reserve/{id}/cancel","href":"/api-reference/all-endpoints/numbers/create-cancel"},{"title":"Get the number-replenishment policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/replenishment-policy","href":"/api-reference/all-endpoints/numbers/get-the-number-replenishment-policy"},{"title":"Update replenishment-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/replenishment-policy","href":"/api-reference/all-endpoints/numbers/update-replenishment-policy"},{"title":"Preview the number-replenishment plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/replenishment-plan","href":"/api-reference/all-endpoints/numbers/preview-the-number-replenishment-plan"},{"title":"Run replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/replenishment/run","href":"/api-reference/all-endpoints/numbers/run-replenishment"},{"title":"Get the reputation-remediation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/reputation-remediation-policy","href":"/api-reference/all-endpoints/numbers/get-the-reputation-remediation-policy"},{"title":"Update reputation-remediation-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/reputation-remediation-policy","href":"/api-reference/all-endpoints/numbers/update-reputation-remediation-policy"},{"title":"Preview the reputation-remediation plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/reputation-remediation-plan","href":"/api-reference/all-endpoints/numbers/preview-the-reputation-remediation-plan"},{"title":"List number-waitlist entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/waitlist","href":"/api-reference/all-endpoints/numbers/list-number-waitlist-entries"},{"title":"Waitlist numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/waitlist","href":"/api-reference/all-endpoints/numbers/waitlist-numbers"},{"title":"List availability","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/waitlist/availability","href":"/api-reference/all-endpoints/numbers/list-availability"},{"title":"Delete waitlist","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/waitlist/{entryId}","href":"/api-reference/all-endpoints/numbers/delete-waitlist"},{"title":"Create repair-provisioning","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/repair-provisioning","href":"/api-reference/all-endpoints/numbers/create-repair-provisioning"},{"title":"Create port-out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/port-out","href":"/api-reference/all-endpoints/numbers/create-port-out"},{"title":"List port-out-protection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/port-out-protection","href":"/api-reference/all-endpoints/numbers/list-port-out-protection"},{"title":"Create port-out-protection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/port-out-protection","href":"/api-reference/all-endpoints/numbers/create-port-out-protection"},{"title":"Delete port-out-protection","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/port-out-protection","href":"/api-reference/all-endpoints/numbers/delete-port-out-protection"},{"title":"Create retry-release","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/retry-release","href":"/api-reference/all-endpoints/numbers/create-retry-release"},{"title":"Patch auto-renew","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/{id}/auto-renew","href":"/api-reference/all-endpoints/numbers/patch-auto-renew"},{"title":"List scheduled-release","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/scheduled-release","href":"/api-reference/all-endpoints/numbers/list-scheduled-release"},{"title":"Update scheduled-release","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/scheduled-release","href":"/api-reference/all-endpoints/numbers/update-scheduled-release"},{"title":"Delete scheduled-release","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/scheduled-release","href":"/api-reference/all-endpoints/numbers/delete-scheduled-release"},{"title":"Patch scheduled-release","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/{id}/scheduled-release","href":"/api-reference/all-endpoints/numbers/patch-scheduled-release"},{"title":"Create suspend","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/suspend","href":"/api-reference/all-endpoints/numbers/create-suspend"},{"title":"Create reactivate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/reactivate","href":"/api-reference/all-endpoints/numbers/create-reactivate"},{"title":"Reassign the number to a sibling subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/reassign","href":"/api-reference/all-endpoints/numbers/reassign-the-number-to-a-sibling-subaccount"},{"title":"Create attach-compliance-profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/attach-compliance-profile","href":"/api-reference/all-endpoints/numbers/create-attach-compliance-profile"},{"title":"Create reclaim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/reclaim","href":"/api-reference/all-endpoints/numbers/create-reclaim"},{"title":"Get the 10DLC warming-tier state for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/warming","href":"/api-reference/all-endpoints/numbers/get-the-10dlc-warming-tier-state-for-a-number"},{"title":"Get the number-warming progression forecast","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/warming/progression","href":"/api-reference/all-endpoints/numbers/get-the-number-warming-progression-forecast"},{"title":"Get the deliverability health score for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/health","href":"/api-reference/all-endpoints/numbers/get-the-deliverability-health-score-for-a-number"},{"title":"Get the deliverability score for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/deliverability-score","href":"/api-reference/all-endpoints/numbers/get-the-deliverability-score-for-a-number"},{"title":"Get the deliverability health trend + forecast for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/health/trend","href":"/api-reference/all-endpoints/numbers/get-the-deliverability-health-trend-+-forecast-for-a-number"},{"title":"Get the predictive spam-likelihood score for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/spam-likelihood","href":"/api-reference/all-endpoints/numbers/get-the-predictive-spam-likelihood-score-for-a-number"},{"title":"List reputation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/reputation","href":"/api-reference/all-endpoints/numbers/list-reputation"},{"title":"List flood-guard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/flood-guard","href":"/api-reference/all-endpoints/numbers/list-flood-guard"},{"title":"Observations reputation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/reputation/observations","href":"/api-reference/all-endpoints/numbers/observations-reputation"},{"title":"Submissions reputation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/reputation/submissions","href":"/api-reference/all-endpoints/numbers/submissions-reputation"},{"title":"Patch submissions","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/{id}/reputation/submissions/{submissionId}","href":"/api-reference/all-endpoints/numbers/patch-submissions"},{"title":"Get SMS spam-complaint feedback loop for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/sms-complaints","href":"/api-reference/all-endpoints/numbers/get-sms-spam-complaint-feedback-loop-for-a-number"},{"title":"Ingest an SMS spam-complaint report for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/sms-complaints/reports","href":"/api-reference/all-endpoints/numbers/ingest-an-sms-spam-complaint-report-for-a-number"},{"title":"Override the SMS complaint suppression hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/{id}/sms-complaints/suppression","href":"/api-reference/all-endpoints/numbers/override-the-sms-complaint-suppression-hold"},{"title":"List usage-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/usage-analytics","href":"/api-reference/all-endpoints/numbers/list-usage-analytics"},{"title":"Per-DID configuration activity log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/activity-log","href":"/api-reference/all-endpoints/numbers/per-did-configuration-activity-log"},{"title":"List network-events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/network-events","href":"/api-reference/all-endpoints/numbers/list-network-events"},{"title":"List cost-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/cost-analytics","href":"/api-reference/all-endpoints/numbers/list-cost-analytics"},{"title":"List branded-calling-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/branded-calling-analytics","href":"/api-reference/all-endpoints/numbers/list-branded-calling-analytics"},{"title":"List branded-calling-cohort","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/branded-calling-cohort","href":"/api-reference/all-endpoints/numbers/list-branded-calling-cohort"},{"title":"List regulator","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/regulator","href":"/api-reference/all-endpoints/numbers/list-regulator"},{"title":"Update regulator","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/regulator","href":"/api-reference/all-endpoints/numbers/update-regulator"},{"title":"List emergency-address","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/emergency-address","href":"/api-reference/all-endpoints/numbers/list-emergency-address"},{"title":"Update emergency-address","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/emergency-address","href":"/api-reference/all-endpoints/numbers/update-emergency-address"},{"title":"Delete emergency-address","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/emergency-address","href":"/api-reference/all-endpoints/numbers/delete-emergency-address"},{"title":"Verify emergency-address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/emergency-address/verify","href":"/api-reference/all-endpoints/numbers/verify-emergency-address"},{"title":"Psap-confirmation emergency-address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/emergency-address/psap-confirmation","href":"/api-reference/all-endpoints/numbers/psap-confirmation-emergency-address"},{"title":"List the dispatchable emergency locations for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/emergency-address/location","href":"/api-reference/all-endpoints/numbers/list-the-dispatchable-emergency-locations-for-a-number"},{"title":"Register or replace a dispatchable emergency location","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/emergency-address/location","href":"/api-reference/all-endpoints/numbers/register-or-replace-a-dispatchable-emergency-location"},{"title":"Update a dispatchable emergency location","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/{id}/emergency-address/location","href":"/api-reference/all-endpoints/numbers/update-a-dispatchable-emergency-location"},{"title":"Remove a dispatchable emergency location for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/emergency-address/location/{deviceKey}","href":"/api-reference/all-endpoints/numbers/remove-a-dispatchable-emergency-location-for-a-number"},{"title":"List cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/cnam","href":"/api-reference/all-endpoints/numbers/list-cnam"},{"title":"Update cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/cnam","href":"/api-reference/all-endpoints/numbers/update-cnam"},{"title":"Delete cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/cnam","href":"/api-reference/all-endpoints/numbers/delete-cnam"},{"title":"List dip","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/cnam/dip","href":"/api-reference/all-endpoints/numbers/list-dip"},{"title":"Get the 411/DA directory listing for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/directory-listing","href":"/api-reference/all-endpoints/numbers/get-the-411da-directory-listing-for-a-number"},{"title":"Set the 411/DA directory listing for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/directory-listing","href":"/api-reference/all-endpoints/numbers/set-the-411da-directory-listing-for-a-number"},{"title":"Remove the 411/DA directory listing for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/directory-listing","href":"/api-reference/all-endpoints/numbers/remove-the-411da-directory-listing-for-a-number"},{"title":"Dispatch the captured directory listing to the wholesale queue","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/directory-listing/dispatch","href":"/api-reference/all-endpoints/numbers/dispatch-the-captured-directory-listing-to-the-wholesale-queue"},{"title":"Get the branded-caller profile for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/branded-caller-profile","href":"/api-reference/all-endpoints/numbers/get-the-branded-caller-profile-for-a-number"},{"title":"Set the branded-caller profile for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/branded-caller-profile","href":"/api-reference/all-endpoints/numbers/set-the-branded-caller-profile-for-a-number"},{"title":"Remove the branded-caller profile for a number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/branded-caller-profile","href":"/api-reference/all-endpoints/numbers/remove-the-branded-caller-profile-for-a-number"},{"title":"Dispatch cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/cnam/dispatch","href":"/api-reference/all-endpoints/numbers/dispatch-cnam"},{"title":"List spam-labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/cnam/spam-labels","href":"/api-reference/all-endpoints/numbers/list-spam-labels"},{"title":"Spam-labels cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/cnam/spam-labels","href":"/api-reference/all-endpoints/numbers/spam-labels-cnam"},{"title":"Remediate cnam","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/cnam/remediate","href":"/api-reference/all-endpoints/numbers/remediate-cnam"},{"title":"List campaign-assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/campaign-assignment","href":"/api-reference/all-endpoints/numbers/list-campaign-assignment"},{"title":"Update campaign-assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/campaign-assignment","href":"/api-reference/all-endpoints/numbers/update-campaign-assignment"},{"title":"Delete campaign-assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{id}/campaign-assignment","href":"/api-reference/all-endpoints/numbers/delete-campaign-assignment"},{"title":"List porting requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting","href":"/api-reference/all-endpoints/numbers/list-porting-requests"},{"title":"Porting numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting","href":"/api-reference/all-endpoints/numbers/porting-numbers"},{"title":"Check port-in eligibility","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/check","href":"/api-reference/all-endpoints/numbers/check-port-in-eligibility"},{"title":"Bulk check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/check/bulk","href":"/api-reference/all-endpoints/numbers/bulk-check"},{"title":"Pre-validate porting","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/pre-validate","href":"/api-reference/all-endpoints/numbers/pre-validate-porting"},{"title":"List port-out requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting/out","href":"/api-reference/all-endpoints/numbers/list-port-out-requests"},{"title":"Submit a port-out request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/out","href":"/api-reference/all-endpoints/numbers/submit-a-port-out-request"},{"title":"Get a port-out request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting/out/{id}","href":"/api-reference/all-endpoints/numbers/get-a-port-out-request"},{"title":"Cancel a port-out request","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/porting/out/{id}","href":"/api-reference/all-endpoints/numbers/cancel-a-port-out-request"},{"title":"Refresh a port-out request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/out/{id}/refresh","href":"/api-reference/all-endpoints/numbers/refresh-a-port-out-request"},{"title":"List toll-free RespOrg change requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting/toll-free/resporg","href":"/api-reference/all-endpoints/numbers/list-toll-free-resporg-change-requests"},{"title":"Submit a toll-free RespOrg change request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/toll-free/resporg","href":"/api-reference/all-endpoints/numbers/submit-a-toll-free-resporg-change-request"},{"title":"Get a toll-free RespOrg change request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting/toll-free/resporg/{id}","href":"/api-reference/all-endpoints/numbers/get-a-toll-free-resporg-change-request"},{"title":"Cancel a toll-free RespOrg change request","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/porting/toll-free/resporg/{id}","href":"/api-reference/all-endpoints/numbers/cancel-a-toll-free-resporg-change-request"},{"title":"Sign the LOA for a toll-free RespOrg change request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/toll-free/resporg/{id}/loa/sign","href":"/api-reference/all-endpoints/numbers/sign-the-loa-for-a-toll-free-resporg-change-request"},{"title":"Cancel a port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/porting/{id}","href":"/api-reference/all-endpoints/numbers/cancel-a-port-in-request"},{"title":"Refresh a port-in request status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/{id}/refresh","href":"/api-reference/all-endpoints/numbers/refresh-a-port-in-request-status"},{"title":"Supplement a rejected port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/{id}/supplement","href":"/api-reference/all-endpoints/numbers/supplement-a-rejected-port-in-request"},{"title":"Bulk-csv port-in","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/port-in/bulk-csv","href":"/api-reference/all-endpoints/numbers/bulk-csv-port-in"},{"title":"Get a port-in request timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/porting/{id}/timeline","href":"/api-reference/all-endpoints/numbers/get-a-port-in-request-timeline"},{"title":"Upload a port-in LOA document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/{id}/loa","href":"/api-reference/all-endpoints/numbers/upload-a-port-in-loa-document"},{"title":"Sign a port-in LOA","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/{id}/loa/sign","href":"/api-reference/all-endpoints/numbers/sign-a-port-in-loa"},{"title":"Submit a signed port-in LOA","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/porting/{id}/loa/submit","href":"/api-reference/all-endpoints/numbers/submit-a-signed-port-in-loa"},{"title":"List hosted-messaging","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/hosted-messaging","href":"/api-reference/all-endpoints/numbers/list-hosted-messaging"},{"title":"Hosted-messaging numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/hosted-messaging","href":"/api-reference/all-endpoints/numbers/hosted-messaging-numbers"},{"title":"Get hosted-messaging","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/hosted-messaging/{id}","href":"/api-reference/all-endpoints/numbers/get-hosted-messaging"},{"title":"Delete hosted-messaging","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/hosted-messaging/{id}","href":"/api-reference/all-endpoints/numbers/delete-hosted-messaging"},{"title":"Sign loa","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/hosted-messaging/{id}/loa/sign","href":"/api-reference/all-endpoints/numbers/sign-loa"},{"title":"Create submit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/hosted-messaging/{id}/submit","href":"/api-reference/all-endpoints/numbers/create-submit"},{"title":"Patch route","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/hosted-messaging/{id}/route","href":"/api-reference/all-endpoints/numbers/patch-route"},{"title":"List short-code applications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/short-codes","href":"/api-reference/all-endpoints/numbers/list-short-code-applications"},{"title":"Open a short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes","href":"/api-reference/all-endpoints/numbers/open-a-short-code-application"},{"title":"Preflight short-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/preflight","href":"/api-reference/all-endpoints/numbers/preflight-short-codes"},{"title":"Create preflight","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/{id}/preflight","href":"/api-reference/all-endpoints/numbers/create-preflight"},{"title":"Get a short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/short-codes/{id}","href":"/api-reference/all-endpoints/numbers/get-a-short-code-application"},{"title":"Cancel a short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/short-codes/{id}","href":"/api-reference/all-endpoints/numbers/cancel-a-short-code-application"},{"title":"Get a short-code application's carrier-vetting timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/short-codes/{id}/timeline","href":"/api-reference/all-endpoints/numbers/get-a-short-code-applications-carrier-vetting-timeline"},{"title":"Update a short-code application's program brief","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/short-codes/{id}/brief","href":"/api-reference/all-endpoints/numbers/update-a-short-code-applications-program-brief"},{"title":"Submit a short-code application for carrier vetting","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/{id}/submit","href":"/api-reference/all-endpoints/numbers/submit-a-short-code-application-for-carrier-vetting"},{"title":"Record per-carrier vetting for a short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/{id}/vetting","href":"/api-reference/all-endpoints/numbers/record-per-carrier-vetting-for-a-short-code-application"},{"title":"Provision a carrier-approved short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/{id}/provision","href":"/api-reference/all-endpoints/numbers/provision-a-carrier-approved-short-code-application"},{"title":"Reject a short-code application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/short-codes/{id}/reject","href":"/api-reference/all-endpoints/numbers/reject-a-short-code-application"},{"title":"List applications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/applications","href":"/api-reference/all-endpoints/numbers/list-applications"},{"title":"Applications numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/applications","href":"/api-reference/all-endpoints/numbers/applications-numbers"},{"title":"Get applications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/applications/{id}","href":"/api-reference/all-endpoints/numbers/get-applications"},{"title":"Delete applications","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/applications/{id}","href":"/api-reference/all-endpoints/numbers/delete-applications"},{"title":"Patch applications","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/applications/{id}","href":"/api-reference/all-endpoints/numbers/patch-applications"},{"title":"Create bind","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/applications/{id}/bind","href":"/api-reference/all-endpoints/numbers/create-bind"},{"title":"Create unbind","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/applications/{id}/unbind","href":"/api-reference/all-endpoints/numbers/create-unbind"},{"title":"List resolve","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/tracking-pools/resolve","href":"/api-reference/all-endpoints/numbers/list-resolve"},{"title":"List tracking-pools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/tracking-pools","href":"/api-reference/all-endpoints/numbers/list-tracking-pools"},{"title":"Tracking-pools numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/tracking-pools","href":"/api-reference/all-endpoints/numbers/tracking-pools-numbers"},{"title":"Get tracking-pools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/tracking-pools/{id}","href":"/api-reference/all-endpoints/numbers/get-tracking-pools"},{"title":"Delete tracking-pools","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/tracking-pools/{id}","href":"/api-reference/all-endpoints/numbers/delete-tracking-pools"},{"title":"Patch tracking-pools","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/tracking-pools/{id}","href":"/api-reference/all-endpoints/numbers/patch-tracking-pools"},{"title":"Create assign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/tracking-pools/{id}/assign","href":"/api-reference/all-endpoints/numbers/create-assign"},{"title":"Create unassign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/tracking-pools/{id}/unassign","href":"/api-reference/all-endpoints/numbers/create-unassign"},{"title":"List international freephone orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/international-freephone","href":"/api-reference/all-endpoints/numbers/list-international-freephone-orders"},{"title":"International-freephone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone","href":"/api-reference/all-endpoints/numbers/international-freephone-numbers"},{"title":"List international freephone coverage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/international-freephone/coverage","href":"/api-reference/all-endpoints/numbers/list-international-freephone-coverage"},{"title":"Search international-freephone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/search","href":"/api-reference/all-endpoints/numbers/search-international-freephone"},{"title":"Get international-freephone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/international-freephone/{id}","href":"/api-reference/all-endpoints/numbers/get-international-freephone"},{"title":"Delete international-freephone","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/international-freephone/{id}","href":"/api-reference/all-endpoints/numbers/delete-international-freephone"},{"title":"Patch international-freephone","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/international-freephone/{id}","href":"/api-reference/all-endpoints/numbers/patch-international-freephone"},{"title":"Create countries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/countries","href":"/api-reference/all-endpoints/numbers/create-countries"},{"title":"Create submit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/submit","href":"/api-reference/all-endpoints/numbers/create-submit-1"},{"title":"Create provision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/provision","href":"/api-reference/all-endpoints/numbers/create-provision"},{"title":"Create activate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/activate","href":"/api-reference/all-endpoints/numbers/create-activate"},{"title":"Create suspend","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/suspend","href":"/api-reference/all-endpoints/numbers/create-suspend-1"},{"title":"Create resume","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/international-freephone/{id}/resume","href":"/api-reference/all-endpoints/numbers/create-resume"},{"title":"Lookup numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/lookup","href":"/api-reference/all-endpoints/numbers/lookup-numbers"},{"title":"Trust-package lookup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/lookup/trust-package","href":"/api-reference/all-endpoints/numbers/trust-package-lookup"},{"title":"Full phone number intelligence lookup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/lookup/{phoneNumber}","href":"/api-reference/all-endpoints/numbers/full-phone-number-intelligence-lookup"},{"title":"Bulk HLR lookup for up to 100 numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/bulk-lookup","href":"/api-reference/all-endpoints/numbers/bulk-hlr-lookup-for-up-to-100-numbers"},{"title":"Number-Intelligence lookup history \u0026 spend analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/lookup-history","href":"/api-reference/all-endpoints/numbers/number-intelligence-lookup-history-\u0026-spend-analytics"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/documents","href":"/api-reference/all-endpoints/numbers/list-documents"},{"title":"Create upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/documents/{docId}/upload","href":"/api-reference/all-endpoints/numbers/create-upload"},{"title":"Refresh documents","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/documents/refresh","href":"/api-reference/all-endpoints/numbers/refresh-documents"},{"title":"Get a number's inbound call/SMS route","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{phoneNumber}/routing","href":"/api-reference/all-endpoints/numbers/get-a-numbers-inbound-callsms-route"},{"title":"Set a number's inbound call/SMS route","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{phoneNumber}/routing","href":"/api-reference/all-endpoints/numbers/set-a-numbers-inbound-callsms-route"},{"title":"Clear a number's inbound route","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/{phoneNumber}/routing","href":"/api-reference/all-endpoints/numbers/clear-a-numbers-inbound-route"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/inbound-resolution/health","href":"/api-reference/all-endpoints/numbers/list-health"},{"title":"Repair inbound-resolution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/inbound-resolution/repair","href":"/api-reference/all-endpoints/numbers/repair-inbound-resolution"},{"title":"List fax-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/fax-routing","href":"/api-reference/all-endpoints/numbers/list-fax-routing"},{"title":"Update fax-routing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/{id}/fax-routing","href":"/api-reference/all-endpoints/numbers/update-fax-routing"},{"title":"List plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/plans","href":"/api-reference/all-endpoints/numbers/list-plans"},{"title":"Get a connectivity data plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/plans/{id}","href":"/api-reference/all-endpoints/numbers/get-a-connectivity-data-plan"},{"title":"List cost-estimate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/plans/{id}/cost-estimate","href":"/api-reference/all-endpoints/numbers/list-cost-estimate"},{"title":"List sims","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/sims","href":"/api-reference/all-endpoints/numbers/list-sims"},{"title":"Sims connectivity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims","href":"/api-reference/all-endpoints/numbers/sims-connectivity"},{"title":"Get a connectivity SIM","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/sims/{iccid}","href":"/api-reference/all-endpoints/numbers/get-a-connectivity-sim"},{"title":"Create activate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/activate","href":"/api-reference/all-endpoints/numbers/create-activate-1"},{"title":"Create suspend","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/suspend","href":"/api-reference/all-endpoints/numbers/create-suspend-2"},{"title":"Create resume","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/resume","href":"/api-reference/all-endpoints/numbers/create-resume-1"},{"title":"Create terminate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/terminate","href":"/api-reference/all-endpoints/numbers/create-terminate"},{"title":"Create ota","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/ota","href":"/api-reference/all-endpoints/numbers/create-ota"},{"title":"List activation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/sims/{iccid}/esim/activation","href":"/api-reference/all-endpoints/numbers/list-activation"},{"title":"Activation esim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/esim/activation","href":"/api-reference/all-endpoints/numbers/activation-esim"},{"title":"Provision esim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/esim/provision","href":"/api-reference/all-endpoints/numbers/provision-esim"},{"title":"Get a connectivity SIM's data usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/sims/{iccid}/usage","href":"/api-reference/all-endpoints/numbers/get-a-connectivity-sims-data-usage"},{"title":"Create usage","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/usage","href":"/api-reference/all-endpoints/numbers/create-usage"},{"title":"Patch quota","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/numbers/connectivity/sims/{iccid}/quota","href":"/api-reference/all-endpoints/numbers/patch-quota"},{"title":"Update authorized-imeis","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/connectivity/sims/{iccid}/authorized-imeis","href":"/api-reference/all-endpoints/numbers/update-authorized-imeis"},{"title":"Send an M2M SMS Command to a SIM's device","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/connectivity/sims/{iccid}/commands","href":"/api-reference/all-endpoints/numbers/send-an-m2m-sms-command-to-a-sims-device"},{"title":"List fleets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/fleets","href":"/api-reference/all-endpoints/numbers/list-fleets"},{"title":"List network-access","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/connectivity/fleets/{fleetId}/network-access","href":"/api-reference/all-endpoints/numbers/list-network-access"},{"title":"Update network-access","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/numbers/connectivity/fleets/{fleetId}/network-access","href":"/api-reference/all-endpoints/numbers/update-network-access"},{"title":"Delete network-access","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/connectivity/fleets/{fleetId}/network-access","href":"/api-reference/all-endpoints/numbers/delete-network-access"},{"title":"List toll-free numbers and their verification status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/tfv","href":"/api-reference/all-endpoints/numbers/list-toll-free-numbers-and-their-verification-status"},{"title":"Lint toll-free sample messages before TFV submission","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/tfv-lint","href":"/api-reference/all-endpoints/numbers/lint-toll-free-sample-messages-before-tfv-submission"},{"title":"List tfv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/{id}/tfv","href":"/api-reference/all-endpoints/numbers/list-tfv"},{"title":"Create tfv-refresh","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/tfv-refresh","href":"/api-reference/all-endpoints/numbers/create-tfv-refresh"},{"title":"Create tfv-submit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/{id}/tfv-submit","href":"/api-reference/all-endpoints/numbers/create-tfv-submit"}]},{"group":"Network APIs","pages":[{"title":"Network APIs operator status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/status","href":"/api-reference/all-endpoints/network-apis/network-apis-operator-status"},{"title":"Create SIM Swap subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/sim-swap/subscriptions","href":"/api-reference/all-endpoints/network-apis/create-sim-swap-subscription"},{"title":"Get SIM Swap subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/sim-swap/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/get-sim-swap-subscription"},{"title":"Delete SIM Swap subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/sim-swap/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/delete-sim-swap-subscription"},{"title":"Create Device Roaming Status subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/device-roaming-status/subscriptions","href":"/api-reference/all-endpoints/network-apis/create-device-roaming-status-subscription"},{"title":"Get Device Roaming Status subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/device-roaming-status/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/get-device-roaming-status-subscription"},{"title":"Delete Device Roaming Status subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/device-roaming-status/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/delete-device-roaming-status-subscription"},{"title":"Create QoD session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/qod-sessions","href":"/api-reference/all-endpoints/network-apis/create-qod-session"},{"title":"Get QoD session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/qod-sessions/{sessionId}","href":"/api-reference/all-endpoints/network-apis/get-qod-session"},{"title":"Delete QoD session","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/qod-sessions/{sessionId}","href":"/api-reference/all-endpoints/network-apis/delete-qod-session"},{"title":"Extend QoD session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/qod-sessions/{sessionId}/extend","href":"/api-reference/all-endpoints/network-apis/extend-qod-session"},{"title":"List network slices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/network-slices","href":"/api-reference/all-endpoints/network-apis/list-network-slices"},{"title":"Book network slice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/network-slices","href":"/api-reference/all-endpoints/network-apis/book-network-slice"},{"title":"Get network slice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/network-slices/{bookingId}","href":"/api-reference/all-endpoints/network-apis/get-network-slice"},{"title":"Release network slice","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/network-slices/{bookingId}","href":"/api-reference/all-endpoints/network-apis/release-network-slice"},{"title":"Create Connectivity Insights subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/connectivity-insights/subscriptions","href":"/api-reference/all-endpoints/network-apis/create-connectivity-insights-subscription"},{"title":"Get Connectivity Insights subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/connectivity-insights/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/get-connectivity-insights-subscription"},{"title":"Delete Connectivity Insights subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/connectivity-insights/subscriptions/{subscriptionId}","href":"/api-reference/all-endpoints/network-apis/delete-connectivity-insights-subscription"},{"title":"List tenant prefix announcements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/numbers/network-apis/internet-access/announcements","href":"/api-reference/all-endpoints/network-apis/list-tenant-prefix-announcements"},{"title":"Start a tenant prefix announcement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/internet-access/announcements","href":"/api-reference/all-endpoints/network-apis/start-a-tenant-prefix-announcement"},{"title":"Withdraw a tenant prefix announcement","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/numbers/network-apis/internet-access/announcements","href":"/api-reference/all-endpoints/network-apis/withdraw-a-tenant-prefix-announcement"},{"title":"List prefix failover events","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/internet-access/failover-events","href":"/api-reference/all-endpoints/network-apis/list-prefix-failover-events"},{"title":"Number Verification (Silent Auth)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/number-verification:verify","href":"/api-reference/all-endpoints/network-apis/number-verification-silent-auth"},{"title":"SIM Swap check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/sim-swap:check","href":"/api-reference/all-endpoints/network-apis/sim-swap-check"},{"title":"SIM Swap retrieve date","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/sim-swap:retrieve-date","href":"/api-reference/all-endpoints/network-apis/sim-swap-retrieve-date"},{"title":"Device Swap check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/device-swap:check","href":"/api-reference/all-endpoints/network-apis/device-swap-check"},{"title":"Number Recycling check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/number-recycling:check","href":"/api-reference/all-endpoints/network-apis/number-recycling-check"},{"title":"KYC Match","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/kyc-match:match","href":"/api-reference/all-endpoints/network-apis/kyc-match"},{"title":"Device Location Verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/device-location:verify","href":"/api-reference/all-endpoints/network-apis/device-location-verification"},{"title":"Device Status reachability","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/device-status:reachability","href":"/api-reference/all-endpoints/network-apis/device-status-reachability"},{"title":"Device Roaming Status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/device-roaming-status:retrieve","href":"/api-reference/all-endpoints/network-apis/device-roaming-status"},{"title":"Carrier Billing charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/carrier-billing:charge","href":"/api-reference/all-endpoints/network-apis/carrier-billing-charge"},{"title":"Age Verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/age-verification:verify","href":"/api-reference/all-endpoints/network-apis/age-verification"},{"title":"Scam Signal assessment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/scam-signal:assess","href":"/api-reference/all-endpoints/network-apis/scam-signal-assessment"},{"title":"Identity Risk Score","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/risk:score","href":"/api-reference/all-endpoints/network-apis/identity-risk-score"},{"title":"Identity Risk Gate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/identity:gate","href":"/api-reference/all-endpoints/network-apis/identity-risk-gate"},{"title":"Connectivity Insights — check network quality","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/connectivity-insights:check-network-quality","href":"/api-reference/all-endpoints/network-apis/connectivity-insights-—-check-network-quality"},{"title":"Assess failover readiness (route holds)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/numbers/network-apis/internet-access/route-holds:assess","href":"/api-reference/all-endpoints/network-apis/assess-failover-readiness-route-holds"}]},{"group":"Brand Identity","pages":[{"title":"Unified cross-channel brand trust posture","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/brand-identity/status","href":"/api-reference/all-endpoints/brand-identity/unified-cross-channel-brand-trust-posture"},{"title":"Read the tenant's brand-impersonation protected-asset watchlist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/brand-identity/impersonation/watchlist","href":"/api-reference/all-endpoints/brand-identity/read-the-tenants-brand-impersonation-protected-asset-watchlist"},{"title":"Replace the tenant's brand-impersonation protected-asset watchlist","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/brand-identity/impersonation/watchlist","href":"/api-reference/all-endpoints/brand-identity/replace-the-tenants-brand-impersonation-protected-asset-watchlist"},{"title":"Scan candidate senders/domains for brand impersonation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/brand-identity/impersonation/scan","href":"/api-reference/all-endpoints/brand-identity/scan-candidate-sendersdomains-for-brand-impersonation"},{"title":"List brand-impersonation takedown cases","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/brand-identity/impersonation/cases","href":"/api-reference/all-endpoints/brand-identity/list-brand-impersonation-takedown-cases"},{"title":"Open a brand-impersonation takedown case","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/brand-identity/impersonation/cases","href":"/api-reference/all-endpoints/brand-identity/open-a-brand-impersonation-takedown-case"},{"title":"Advance or dismiss a brand-impersonation takedown case","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/brand-identity/impersonation/cases/{caseId}","href":"/api-reference/all-endpoints/brand-identity/advance-or-dismiss-a-brand-impersonation-takedown-case"}]},{"group":"Verify","pages":[{"title":"List verifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify","href":"/api-reference/all-endpoints/verify/list-verifications"},{"title":"Verification analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/analytics","href":"/api-reference/all-endpoints/verify/verification-analytics"},{"title":"Verify Fraud Guard analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/fraud-analytics","href":"/api-reference/all-endpoints/verify/verify-fraud-guard-analytics"},{"title":"Verify Fraud Shield conversion anomaly","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/conversion-anomaly","href":"/api-reference/all-endpoints/verify/verify-fraud-shield-conversion-anomaly"},{"title":"Export AIT chargeback evidence (CSV)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/conversion-anomaly/evidence-export.csv","href":"/api-reference/all-endpoints/verify/export-ait-chargeback-evidence-csv"},{"title":"Get verification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/{id}","href":"/api-reference/all-endpoints/verify/get-verification"},{"title":"Get verification detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/{id}/detail","href":"/api-reference/all-endpoints/verify/get-verification-detail"},{"title":"Send a verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/send","href":"/api-reference/all-endpoints/verify/send-a-verification-code"},{"title":"Send bulk verifications","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/bulk","href":"/api-reference/all-endpoints/verify/send-bulk-verifications"},{"title":"Check a verification code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/check","href":"/api-reference/all-endpoints/verify/check-a-verification-code"},{"title":"Score phone-number fraud risk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/fraud-score","href":"/api-reference/all-endpoints/verify/score-phone-number-fraud-risk"},{"title":"Identity-verification fraud gate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/fraud-gate","href":"/api-reference/all-endpoints/verify/identity-verification-fraud-gate"},{"title":"Resend verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/{id}/resend","href":"/api-reference/all-endpoints/verify/resend-verification"},{"title":"Cancel verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/{id}/cancel","href":"/api-reference/all-endpoints/verify/cancel-verification"},{"title":"List verification profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/profiles","href":"/api-reference/all-endpoints/verify/list-verification-profiles"},{"title":"Create verification profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/profiles","href":"/api-reference/all-endpoints/verify/create-verification-profile"},{"title":"Get verification profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/profiles/{id}","href":"/api-reference/all-endpoints/verify/get-verification-profile"},{"title":"Delete verification profile","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/verify/profiles/{id}","href":"/api-reference/all-endpoints/verify/delete-verification-profile"},{"title":"Update verification profile","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/verify/profiles/{id}","href":"/api-reference/all-endpoints/verify/update-verification-profile"},{"title":"List verification configs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/configs","href":"/api-reference/all-endpoints/verify/list-verification-configs"},{"title":"Create verification config","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/configs","href":"/api-reference/all-endpoints/verify/create-verification-config"},{"title":"Get verification config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/configs/{id}","href":"/api-reference/all-endpoints/verify/get-verification-config"},{"title":"Delete verification config","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/verify/configs/{id}","href":"/api-reference/all-endpoints/verify/delete-verification-config"},{"title":"Update verification config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/verify/configs/{id}","href":"/api-reference/all-endpoints/verify/update-verification-config"},{"title":"List all verification factors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/factors","href":"/api-reference/all-endpoints/verify/list-all-verification-factors"},{"title":"List totp","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/factors/totp","href":"/api-reference/all-endpoints/verify/list-totp"},{"title":"Create TOTP factor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/factors/totp","href":"/api-reference/all-endpoints/verify/create-totp-factor"},{"title":"Verify TOTP code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/factors/totp/{id}/verify","href":"/api-reference/all-endpoints/verify/verify-totp-code"},{"title":"Delete totp","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/verify/factors/totp/{id}","href":"/api-reference/all-endpoints/verify/delete-totp"},{"title":"Regenerate TOTP recovery codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/factors/totp/{id}/recovery-codes/regenerate","href":"/api-reference/all-endpoints/verify/regenerate-totp-recovery-codes"},{"title":"List backup-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/factors/backup-codes","href":"/api-reference/all-endpoints/verify/list-backup-codes"},{"title":"Create backup-code factor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/factors/backup-codes","href":"/api-reference/all-endpoints/verify/create-backup-code-factor"},{"title":"Verify backup code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/factors/backup-codes/{id}/verify","href":"/api-reference/all-endpoints/verify/verify-backup-code"},{"title":"Delete backup-codes","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/verify/factors/backup-codes/{id}","href":"/api-reference/all-endpoints/verify/delete-backup-codes"},{"title":"List pending","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/approvals/pending","href":"/api-reference/all-endpoints/verify/list-pending"},{"title":"Create approve","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/approvals/{id}/approve","href":"/api-reference/all-endpoints/verify/create-approve"},{"title":"Create reject","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/approvals/{id}/reject","href":"/api-reference/all-endpoints/verify/create-reject"},{"title":"List settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/approvals/settings","href":"/api-reference/all-endpoints/verify/list-settings"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/verify/approvals/settings","href":"/api-reference/all-endpoints/verify/update-settings"},{"title":"Consume a magic-link token","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/verify/magic-link/consume","href":"/api-reference/all-endpoints/verify/consume-a-magic-link-token"}]},{"group":"Voice Biometrics","pages":[{"title":"Voice biometrics overview","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/voice-biometrics/overview","href":"/api-reference/all-endpoints/voice-biometrics/voice-biometrics-overview"},{"title":"Update voice biometrics tenant settings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/verify/voice-biometrics/settings","href":"/api-reference/all-endpoints/voice-biometrics/update-voice-biometrics-tenant-settings"},{"title":"Enroll a voiceprint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/voice-biometrics/enroll","href":"/api-reference/all-endpoints/voice-biometrics/enroll-a-voiceprint"},{"title":"Get voiceprint enrollment status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/voice-biometrics/enroll/{id}","href":"/api-reference/all-endpoints/voice-biometrics/get-voiceprint-enrollment-status"},{"title":"Verify a caller by voice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/voice-biometrics/verify","href":"/api-reference/all-endpoints/voice-biometrics/verify-a-caller-by-voice"},{"title":"Issue a verification challenge nonce","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/voice-biometrics/challenge","href":"/api-reference/all-endpoints/voice-biometrics/issue-a-verification-challenge-nonce"},{"title":"List enrolled voiceprints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/verify/voice-biometrics","href":"/api-reference/all-endpoints/voice-biometrics/list-enrolled-voiceprints"},{"title":"Delete a voiceprint (GDPR erasure)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/verify/voice-biometrics/{voiceprintId}","href":"/api-reference/all-endpoints/voice-biometrics/delete-a-voiceprint-gdpr-erasure"}]},{"group":"Verify Push","pages":[{"title":"Register a push factor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/push/factors","href":"/api-reference/all-endpoints/verify-push/register-a-push-factor"},{"title":"Issue a push challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/push/factors/{factorId}/challenges","href":"/api-reference/all-endpoints/verify-push/issue-a-push-challenge"},{"title":"Verify a push challenge signature","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/push/challenges/{challengeId}/verify","href":"/api-reference/all-endpoints/verify-push/verify-a-push-challenge-signature"},{"title":"Revoke a push factor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/push/factors/{factorId}/revoke","href":"/api-reference/all-endpoints/verify-push/revoke-a-push-factor"}]},{"group":"Verify Passkey","pages":[{"title":"Issue WebAuthn registration options","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/passkey/registration/options","href":"/api-reference/all-endpoints/verify-passkey/issue-webauthn-registration-options"},{"title":"Verify WebAuthn registration attestation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/passkey/registration/verify","href":"/api-reference/all-endpoints/verify-passkey/verify-webauthn-registration-attestation"},{"title":"Issue WebAuthn authentication options","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/passkey/authentication/options","href":"/api-reference/all-endpoints/verify-passkey/issue-webauthn-authentication-options"},{"title":"Verify WebAuthn authentication assertion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/passkey/authentication/verify","href":"/api-reference/all-endpoints/verify-passkey/verify-webauthn-authentication-assertion"},{"title":"Revoke a passkey factor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/verify/passkey/factors/{factorId}/revoke","href":"/api-reference/all-endpoints/verify-passkey/revoke-a-passkey-factor"}]},{"group":"Risk","pages":[{"title":"Unified cross-channel Trust \u0026 Fraud risk score for a destination","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/risk/score","href":"/api-reference/all-endpoints/risk/unified-cross-channel-trust-\u0026-fraud-risk-score-for-a-destination"}]},{"group":"Flows","pages":[{"title":"Resume a paused flow execution","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/executions/{id}/resume","href":"/api-reference/all-endpoints/flows/resume-a-paused-flow-execution"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows","href":"/api-reference/all-endpoints/flows/list-flows"},{"title":"Create flows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows","href":"/api-reference/all-endpoints/flows/create-flows"},{"title":"List flow executions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/executions","href":"/api-reference/all-endpoints/flows/list-flow-executions"},{"title":"Aggregate flow execution statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/executions/summary","href":"/api-reference/all-endpoints/flows/aggregate-flow-execution-statistics"},{"title":"Get a flow execution","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/executions/{id}","href":"/api-reference/all-endpoints/flows/get-a-flow-execution"},{"title":"List flow templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/templates","href":"/api-reference/all-endpoints/flows/list-flow-templates"},{"title":"Get flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}","href":"/api-reference/all-endpoints/flows/get-flows"},{"title":"Update flows","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/flows/{id}","href":"/api-reference/all-endpoints/flows/update-flows"},{"title":"Delete flows","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/flows/{id}","href":"/api-reference/all-endpoints/flows/delete-flows"},{"title":"Validate a flow graph before publish","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}/validate","href":"/api-reference/all-endpoints/flows/validate-a-flow-graph-before-publish"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}/analytics","href":"/api-reference/all-endpoints/flows/list-analytics"},{"title":"List ab-results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}/ab-results","href":"/api-reference/all-endpoints/flows/list-ab-results"},{"title":"Create simulate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/simulate","href":"/api-reference/all-endpoints/flows/create-simulate"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}/export","href":"/api-reference/all-endpoints/flows/list-export"},{"title":"Create execute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/execute","href":"/api-reference/all-endpoints/flows/create-execute"},{"title":"Create start","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/start","href":"/api-reference/all-endpoints/flows/create-start"},{"title":"Create publish","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/publish","href":"/api-reference/all-endpoints/flows/create-publish"},{"title":"Unpublish a flow","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/unpublish","href":"/api-reference/all-endpoints/flows/unpublish-a-flow"},{"title":"List flow version snapshots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/flows/{id}/versions","href":"/api-reference/all-endpoints/flows/list-flow-version-snapshots"},{"title":"Create a flow version snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/versions","href":"/api-reference/all-endpoints/flows/create-a-flow-version-snapshot"},{"title":"Restore a flow version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/flows/{id}/versions/{versionId}/restore","href":"/api-reference/all-endpoints/flows/restore-a-flow-version"}]},{"group":"Settings","pages":[{"title":"Get the current organization record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/organization","href":"/api-reference/all-endpoints/settings/get-the-current-organization-record"},{"title":"Get user preferences","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/preferences","href":"/api-reference/all-endpoints/settings/get-user-preferences"},{"title":"Update user preferences","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/preferences","href":"/api-reference/all-endpoints/settings/update-user-preferences"},{"title":"List in-app notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/notifications","href":"/api-reference/all-endpoints/settings/list-in-app-notifications"},{"title":"Clear all in-app notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/notifications","href":"/api-reference/all-endpoints/settings/clear-all-in-app-notifications"},{"title":"Mark a notification as read","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/notifications/{id}/read","href":"/api-reference/all-endpoints/settings/mark-a-notification-as-read"},{"title":"Get general workspace settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/general","href":"/api-reference/all-endpoints/settings/get-general-workspace-settings"},{"title":"Update general workspace settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/general","href":"/api-reference/all-endpoints/settings/update-general-workspace-settings"},{"title":"List team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/team","href":"/api-reference/all-endpoints/settings/list-team-members"},{"title":"List recent team activity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/team/activity","href":"/api-reference/all-endpoints/settings/list-recent-team-activity"},{"title":"Invite a team member","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/team/invite","href":"/api-reference/all-endpoints/settings/invite-a-team-member"},{"title":"Change a team member's role","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/team/{userId}","href":"/api-reference/all-endpoints/settings/change-a-team-members-role"},{"title":"Remove a team member","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/team/{userId}","href":"/api-reference/all-endpoints/settings/remove-a-team-member"},{"title":"Set a team member's routing skills","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/team/{userId}/skills","href":"/api-reference/all-endpoints/settings/set-a-team-members-routing-skills"},{"title":"List pending invitations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/team/invites","href":"/api-reference/all-endpoints/settings/list-pending-invitations"},{"title":"Cancel a pending team invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/team/invites/{email}","href":"/api-reference/all-endpoints/settings/cancel-a-pending-team-invitation"},{"title":"Resend a pending team invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/team/invites/{email}/resend","href":"/api-reference/all-endpoints/settings/resend-a-pending-team-invitation"},{"title":"Resend pending team invitations in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/team/invites/bulk-resend","href":"/api-reference/all-endpoints/settings/resend-pending-team-invitations-in-bulk"},{"title":"Accept a team invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/team/accept-invite","href":"/api-reference/all-endpoints/settings/accept-a-team-invitation"},{"title":"Resolve a team invitation token","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/team/invites/resolve/{token}","href":"/api-reference/all-endpoints/settings/resolve-a-team-invitation-token"},{"title":"Invite team members in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/team/invites/bulk","href":"/api-reference/all-endpoints/settings/invite-team-members-in-bulk"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/api-keys","href":"/api-reference/all-endpoints/settings/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/api-keys","href":"/api-reference/all-endpoints/settings/create-an-api-key"},{"title":"Revoke multiple API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/api-keys/bulk-revoke","href":"/api-reference/all-endpoints/settings/revoke-multiple-api-keys"},{"title":"Revoke an API key immediately","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/api-keys/{id}","href":"/api-reference/all-endpoints/settings/revoke-an-api-key-immediately"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/api-keys/{id}/rotate","href":"/api-reference/all-endpoints/settings/rotate-an-api-key"},{"title":"Schedule an API key revocation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/api-keys/{id}/schedule-revoke","href":"/api-reference/all-endpoints/settings/schedule-an-api-key-revocation"},{"title":"Cancel a scheduled revocation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/api-keys/{id}/cancel-revoke","href":"/api-reference/all-endpoints/settings/cancel-a-scheduled-revocation"},{"title":"Get an API key's IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/api-keys/{id}/allowed-ips","href":"/api-reference/all-endpoints/settings/get-an-api-keys-ip-allowlist"},{"title":"Replace an API key's IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/api-keys/{id}/allowed-ips","href":"/api-reference/all-endpoints/settings/replace-an-api-keys-ip-allowlist"},{"title":"List sender IDs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/sender-ids","href":"/api-reference/all-endpoints/settings/list-sender-ids"},{"title":"Register a sender ID","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/sender-ids","href":"/api-reference/all-endpoints/settings/register-a-sender-id"},{"title":"Update a sender ID's status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/sender-ids/{id}/status","href":"/api-reference/all-endpoints/settings/update-a-sender-ids-status"},{"title":"Delete a sender ID","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/sender-ids/{id}","href":"/api-reference/all-endpoints/settings/delete-a-sender-id"},{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/custom-fields","href":"/api-reference/all-endpoints/settings/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/custom-fields","href":"/api-reference/all-endpoints/settings/create-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/custom-fields/{id}","href":"/api-reference/all-endpoints/settings/update-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/custom-fields/{id}","href":"/api-reference/all-endpoints/settings/delete-a-custom-field-definition"},{"title":"List channel configurations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels","href":"/api-reference/all-endpoints/settings/list-channel-configurations"},{"title":"Get a channel configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels/{channel}","href":"/api-reference/all-endpoints/settings/get-a-channel-configuration"},{"title":"Update a channel configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/channels/{channel}","href":"/api-reference/all-endpoints/settings/update-a-channel-configuration"},{"title":"Get a channel status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels/{channel}/status","href":"/api-reference/all-endpoints/settings/get-a-channel-status"},{"title":"Get cross-channel fallback configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels-fallback","href":"/api-reference/all-endpoints/settings/get-cross-channel-fallback-configuration"},{"title":"Update cross-channel fallback configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/channels-fallback","href":"/api-reference/all-endpoints/settings/update-cross-channel-fallback-configuration"},{"title":"Verify email DNS against the stored domain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/email/verify-dns","href":"/api-reference/all-endpoints/settings/verify-email-dns-against-the-stored-domain"},{"title":"Probe the stored LINE token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/line/verify","href":"/api-reference/all-endpoints/settings/probe-the-stored-line-token"},{"title":"List recent sign-in sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/login-history","href":"/api-reference/all-endpoints/settings/list-recent-sign-in-sessions"},{"title":"Revoke one of your active sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/sessions/{sessionId}","href":"/api-reference/all-endpoints/settings/revoke-one-of-your-active-sessions"},{"title":"List your active sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/sessions","href":"/api-reference/all-endpoints/settings/list-your-active-sessions"},{"title":"Get verify / OTP configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/verify-config","href":"/api-reference/all-endpoints/settings/get-verify-otp-configuration"},{"title":"Update verify / OTP configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/verify-config","href":"/api-reference/all-endpoints/settings/update-verify-otp-configuration"},{"title":"Get branded-calling configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/branded-calling","href":"/api-reference/all-endpoints/settings/get-branded-calling-configuration"},{"title":"Update branded-calling configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/branded-calling","href":"/api-reference/all-endpoints/settings/update-branded-calling-configuration"},{"title":"Submit verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/branded-calling/verification/submit","href":"/api-reference/all-endpoints/settings/submit-verification"},{"title":"Read per-carrier RCD provisioning state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/branded-calling/rcd-provisioning","href":"/api-reference/all-endpoints/settings/read-per-carrier-rcd-provisioning-state"},{"title":"Create submit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/branded-calling/rcd-provisioning/{carrier}/submit","href":"/api-reference/all-endpoints/settings/create-submit"},{"title":"Get the per-conversation AI soft-budget defaults","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agent-budget-defaults","href":"/api-reference/all-endpoints/settings/get-the-per-conversation-ai-soft-budget-defaults"},{"title":"Update agent-budget-defaults","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agent-budget-defaults","href":"/api-reference/all-endpoints/settings/update-agent-budget-defaults"},{"title":"Get the admin approval-requirements configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/action-approvals","href":"/api-reference/all-endpoints/settings/get-the-admin-approval-requirements-configuration"},{"title":"Update action-approvals","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/action-approvals","href":"/api-reference/all-endpoints/settings/update-action-approvals"},{"title":"List IP allowlist entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/ip-allowlist","href":"/api-reference/all-endpoints/settings/list-ip-allowlist-entries"},{"title":"Add an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/ip-allowlist","href":"/api-reference/all-endpoints/settings/add-an-ip-allowlist-entry"},{"title":"Get the caller's current IP","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/ip-allowlist/current-ip","href":"/api-reference/all-endpoints/settings/get-the-callers-current-ip"},{"title":"Remove an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/ip-allowlist/{id}","href":"/api-reference/all-endpoints/settings/remove-an-ip-allowlist-entry"},{"title":"List integrations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/integrations","href":"/api-reference/all-endpoints/settings/list-integrations"},{"title":"Update an integration's connection state","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/integrations/{id}","href":"/api-reference/all-endpoints/settings/update-an-integrations-connection-state"},{"title":"Disconnect an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/integrations/{id}","href":"/api-reference/all-endpoints/settings/disconnect-an-integration"},{"title":"Get the SAML SSO configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/sso","href":"/api-reference/all-endpoints/settings/get-the-saml-sso-configuration"},{"title":"Update the SAML SSO configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/sso","href":"/api-reference/all-endpoints/settings/update-the-saml-sso-configuration"},{"title":"Export audit log entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/audit-logs/export","href":"/api-reference/all-endpoints/settings/export-audit-log-entries"},{"title":"Enqueue an async audit-log export","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/audit-logs/export-async","href":"/api-reference/all-endpoints/settings/enqueue-an-async-audit-log-export"},{"title":"List audit-log export jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/audit-logs/export-jobs","href":"/api-reference/all-endpoints/settings/list-audit-log-export-jobs"},{"title":"Get one audit-log export job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/audit-logs/export-jobs/{id}","href":"/api-reference/all-endpoints/settings/get-one-audit-log-export-job"},{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/audit-logs","href":"/api-reference/all-endpoints/settings/list-audit-log-entries"},{"title":"List keyword rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/keyword-rules","href":"/api-reference/all-endpoints/settings/list-keyword-rules"},{"title":"Create a keyword rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/keyword-rules","href":"/api-reference/all-endpoints/settings/create-a-keyword-rule"},{"title":"Update a keyword rule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/keyword-rules/{id}","href":"/api-reference/all-endpoints/settings/update-a-keyword-rule"},{"title":"Delete a keyword rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/keyword-rules/{id}","href":"/api-reference/all-endpoints/settings/delete-a-keyword-rule"},{"title":"List opt-out rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/opt-out-rules","href":"/api-reference/all-endpoints/settings/list-opt-out-rules"},{"title":"Bulk update opt-out rules","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/opt-out-rules","href":"/api-reference/all-endpoints/settings/bulk-update-opt-out-rules"},{"title":"Create an opt-out keyword rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/opt-out-rules","href":"/api-reference/all-endpoints/settings/create-an-opt-out-keyword-rule"},{"title":"Delete an opt-out keyword rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/opt-out-rules/{id}","href":"/api-reference/all-endpoints/settings/delete-an-opt-out-keyword-rule"},{"title":"Get HIPAA mode status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/hipaa","href":"/api-reference/all-endpoints/settings/get-hipaa-mode-status"},{"title":"Enable or disable HIPAA mode","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/hipaa","href":"/api-reference/all-endpoints/settings/enable-or-disable-hipaa-mode"},{"title":"Mint a re-auth challenge for disabling HIPAA mode","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/hipaa/reauth-challenge","href":"/api-reference/all-endpoints/settings/mint-a-re-auth-challenge-for-disabling-hipaa-mode"},{"title":"Mint a re-auth challenge for force-transferring a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/inbox/reauth-challenge","href":"/api-reference/all-endpoints/settings/mint-a-re-auth-challenge-for-force-transferring-a-conversation"},{"title":"List PHI access log entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/hipaa/phi-access-log","href":"/api-reference/all-endpoints/settings/list-phi-access-log-entries"},{"title":"Record Business Associate Agreement status","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/hipaa/baa","href":"/api-reference/all-endpoints/settings/record-business-associate-agreement-status"},{"title":"Get the data retention policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/retention","href":"/api-reference/all-endpoints/settings/get-the-data-retention-policy"},{"title":"Update data retention overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/retention","href":"/api-reference/all-endpoints/settings/update-data-retention-overrides"},{"title":"Get the agent daily spend cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agents/spend-cap","href":"/api-reference/all-endpoints/settings/get-the-agent-daily-spend-cap"},{"title":"Set the agent daily spend cap","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agents/spend-cap","href":"/api-reference/all-endpoints/settings/set-the-agent-daily-spend-cap"},{"title":"Read the semantic response cache config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agents/semantic-cache","href":"/api-reference/all-endpoints/settings/read-the-semantic-response-cache-config"},{"title":"Update semantic-cache","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agents/semantic-cache","href":"/api-reference/all-endpoints/settings/update-semantic-cache"},{"title":"Read the org-wide agent cost cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agents/cost-cap","href":"/api-reference/all-endpoints/settings/read-the-org-wide-agent-cost-cap"},{"title":"Update cost-cap","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agents/cost-cap","href":"/api-reference/all-endpoints/settings/update-cost-cap"},{"title":"Read the per-conversation soft budget","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agents/conversation-budget","href":"/api-reference/all-endpoints/settings/read-the-per-conversation-soft-budget"},{"title":"Update conversation-budget","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agents/conversation-budget","href":"/api-reference/all-endpoints/settings/update-conversation-budget"},{"title":"List canned responses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/canned-responses","href":"/api-reference/all-endpoints/settings/list-canned-responses"},{"title":"Create a canned response","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/canned-responses","href":"/api-reference/all-endpoints/settings/create-a-canned-response"},{"title":"Update a canned response","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/canned-responses/{id}","href":"/api-reference/all-endpoints/settings/update-a-canned-response"},{"title":"Delete a canned response","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/canned-responses/{id}","href":"/api-reference/all-endpoints/settings/delete-a-canned-response"},{"title":"Connect a Meta channel via Facebook Login","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/instagram/connect","href":"/api-reference/all-endpoints/settings/connect-a-meta-channel-via-facebook-login"},{"title":"Disconnect a Meta channel","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/channels/instagram/disconnect","href":"/api-reference/all-endpoints/settings/disconnect-a-meta-channel"},{"title":"Connect a Meta channel via Facebook Login","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/messenger/connect","href":"/api-reference/all-endpoints/settings/connect-a-meta-channel-via-facebook-login-1"},{"title":"Disconnect a Meta channel","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/channels/messenger/disconnect","href":"/api-reference/all-endpoints/settings/disconnect-a-meta-channel-1"},{"title":"List Messenger personas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels/messenger/personas","href":"/api-reference/all-endpoints/settings/list-messenger-personas"},{"title":"Create a Messenger persona","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/messenger/personas","href":"/api-reference/all-endpoints/settings/create-a-messenger-persona"},{"title":"Delete a Messenger persona","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/channels/messenger/personas/{personaId}","href":"/api-reference/all-endpoints/settings/delete-a-messenger-persona"},{"title":"Submit tier2","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/channels/viber/tier2/submit","href":"/api-reference/all-endpoints/settings/submit-tier2"},{"title":"Read Viber tier-2 verification status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/channels/viber/tier2/status","href":"/api-reference/all-endpoints/settings/read-viber-tier-2-verification-status"},{"title":"Get the compliance health summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance-health","href":"/api-reference/all-endpoints/settings/get-the-compliance-health-summary"},{"title":"Get the pre-send policy scan mode","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/policy-scan-mode","href":"/api-reference/all-endpoints/settings/get-the-pre-send-policy-scan-mode"},{"title":"Set the pre-send policy scan mode","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/compliance/policy-scan-mode","href":"/api-reference/all-endpoints/settings/set-the-pre-send-policy-scan-mode"},{"title":"List unknown-marketing-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/unknown-marketing-policy","href":"/api-reference/all-endpoints/settings/list-unknown-marketing-policy"},{"title":"Set the unknown-consent marketing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/compliance/unknown-marketing-policy","href":"/api-reference/all-endpoints/settings/set-the-unknown-consent-marketing-policy"},{"title":"List consent-default-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/consent-default-policy","href":"/api-reference/all-endpoints/settings/list-consent-default-policy"},{"title":"Set the CDP consent-default policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/compliance/consent-default-policy","href":"/api-reference/all-endpoints/settings/set-the-cdp-consent-default-policy"},{"title":"List inbound-country-gate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/inbound-country-gate","href":"/api-reference/all-endpoints/settings/list-inbound-country-gate"},{"title":"Update inbound-country-gate","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/compliance/inbound-country-gate","href":"/api-reference/all-endpoints/settings/update-inbound-country-gate"},{"title":"Get the outbound country allowlist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/country-allowlist","href":"/api-reference/all-endpoints/settings/get-the-outbound-country-allowlist"},{"title":"Replace the outbound country allowlist","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/compliance/country-allowlist","href":"/api-reference/all-endpoints/settings/replace-the-outbound-country-allowlist"},{"title":"List fraud-caps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/fraud-caps","href":"/api-reference/all-endpoints/settings/list-fraud-caps"},{"title":"Update fraud-caps","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/compliance/fraud-caps","href":"/api-reference/all-endpoints/settings/update-fraud-caps"},{"title":"List voice-destination-blocks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/voice-destination-blocks","href":"/api-reference/all-endpoints/settings/list-voice-destination-blocks"},{"title":"List fraud-mitigations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/fraud-mitigations","href":"/api-reference/all-endpoints/settings/list-fraud-mitigations"},{"title":"Delete fraud-mitigations","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/compliance/fraud-mitigations/{channel}","href":"/api-reference/all-endpoints/settings/delete-fraud-mitigations"},{"title":"List channel-rate-overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/channel-rate-overrides","href":"/api-reference/all-endpoints/settings/list-channel-rate-overrides"},{"title":"Update channel-rate-overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/compliance/channel-rate-overrides","href":"/api-reference/all-endpoints/settings/update-channel-rate-overrides"},{"title":"List ai-turn-audit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/ai-turn-audit","href":"/api-reference/all-endpoints/settings/list-ai-turn-audit"},{"title":"Update ai-turn-audit","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/compliance/ai-turn-audit","href":"/api-reference/all-endpoints/settings/update-ai-turn-audit"},{"title":"List inbox-ai-privacy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/inbox-ai-privacy","href":"/api-reference/all-endpoints/settings/list-inbox-ai-privacy"},{"title":"Set inbox AI privacy opt-outs","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/compliance/inbox-ai-privacy","href":"/api-reference/all-endpoints/settings/set-inbox-ai-privacy-opt-outs"},{"title":"Get the org quiet-hours policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/compliance/quiet-hours","href":"/api-reference/all-endpoints/settings/get-the-org-quiet-hours-policy"},{"title":"Replace the org quiet-hours policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/compliance/quiet-hours","href":"/api-reference/all-endpoints/settings/replace-the-org-quiet-hours-policy"},{"title":"Mint a 2FA step-up challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/2fa/challenge","href":"/api-reference/all-endpoints/settings/mint-a-2fa-step-up-challenge"},{"title":"Disable two-factor authentication","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/2fa/disable","href":"/api-reference/all-endpoints/settings/disable-two-factor-authentication"},{"title":"Regenerate 2FA backup codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/2fa/backup-codes/regenerate","href":"/api-reference/all-endpoints/settings/regenerate-2fa-backup-codes"},{"title":"Get 2FA backup-codes status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/security/2fa/backup-codes/status","href":"/api-reference/all-endpoints/settings/get-2fa-backup-codes-status"},{"title":"Password-changed security","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/password-changed","href":"/api-reference/all-endpoints/settings/password-changed-security"},{"title":"Get the per-role 2FA requirement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/security/require-2fa","href":"/api-reference/all-endpoints/settings/get-the-per-role-2fa-requirement"},{"title":"Update the per-role 2FA requirement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/require-2fa","href":"/api-reference/all-endpoints/settings/update-the-per-role-2fa-requirement"},{"title":"List support-access","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/security/support-access","href":"/api-reference/all-endpoints/settings/list-support-access"},{"title":"Grant support-access","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/support-access/grant","href":"/api-reference/all-endpoints/settings/grant-support-access"},{"title":"Deny support-access","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/support-access/deny","href":"/api-reference/all-endpoints/settings/deny-support-access"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/security/support-access/sessions","href":"/api-reference/all-endpoints/settings/list-sessions"},{"title":"Create end","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/security/support-access/sessions/{jti}/end","href":"/api-reference/all-endpoints/settings/create-end"},{"title":"Get the native chat widget configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/native-chat","href":"/api-reference/all-endpoints/settings/get-the-native-chat-widget-configuration"},{"title":"Update the native chat widget configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/native-chat","href":"/api-reference/all-endpoints/settings/update-the-native-chat-widget-configuration"},{"title":"Enable or disable the native chat widget","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/native-chat/disable","href":"/api-reference/all-endpoints/settings/enable-or-disable-the-native-chat-widget"},{"title":"Enable or disable the native chat widget","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/native-chat/enable","href":"/api-reference/all-endpoints/settings/enable-or-disable-the-native-chat-widget-1"},{"title":"Get the native chat widget install snippet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/native-chat/install","href":"/api-reference/all-endpoints/settings/get-the-native-chat-widget-install-snippet"},{"title":"List flow","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/native-chat/flow","href":"/api-reference/all-endpoints/settings/list-flow"},{"title":"Publish the native chat conversation flow","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/native-chat/flow","href":"/api-reference/all-endpoints/settings/publish-the-native-chat-conversation-flow"},{"title":"List signup-forms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/native-chat/signup-forms","href":"/api-reference/all-endpoints/settings/list-signup-forms"},{"title":"Publish the native chat sign-up forms","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/native-chat/signup-forms","href":"/api-reference/all-endpoints/settings/publish-the-native-chat-sign-up-forms"},{"title":"List agent-trust-policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/native-chat/agent-trust-policy","href":"/api-reference/all-endpoints/settings/list-agent-trust-policy"},{"title":"Publish the native chat agent trust policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/native-chat/agent-trust-policy","href":"/api-reference/all-endpoints/settings/publish-the-native-chat-agent-trust-policy"},{"title":"List voice-agent-widget","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/voice-agent-widget","href":"/api-reference/all-endpoints/settings/list-voice-agent-widget"},{"title":"Update voice-agent-widget","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/voice-agent-widget","href":"/api-reference/all-endpoints/settings/update-voice-agent-widget"},{"title":"List install","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/voice-agent-widget/install","href":"/api-reference/all-endpoints/settings/list-install"},{"title":"Get privacy settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/privacy","href":"/api-reference/all-endpoints/settings/get-privacy-settings"},{"title":"Update privacy settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/privacy","href":"/api-reference/all-endpoints/settings/update-privacy-settings"},{"title":"List recording-redaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/recording-redaction","href":"/api-reference/all-endpoints/settings/list-recording-redaction"},{"title":"Update recording-redaction","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/recording-redaction","href":"/api-reference/all-endpoints/settings/update-recording-redaction"},{"title":"List per-agent per-channel concurrency caps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agent-channel-caps","href":"/api-reference/all-endpoints/settings/list-per-agent-per-channel-concurrency-caps"},{"title":"Upsert one per-agent per-channel concurrency cap","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agent-channel-caps","href":"/api-reference/all-endpoints/settings/upsert-one-per-agent-per-channel-concurrency-cap"},{"title":"Bulk upsert per-agent per-channel concurrency caps","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/settings/agent-channel-caps/bulk","href":"/api-reference/all-endpoints/settings/bulk-upsert-per-agent-per-channel-concurrency-caps"},{"title":"Clear a per-agent per-channel concurrency cap","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/settings/agent-channel-caps/{agentUserId}/{channel}","href":"/api-reference/all-endpoints/settings/clear-a-per-agent-per-channel-concurrency-cap"},{"title":"List agent identity records — inventory of every Orbit AI agent as a non-human identity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/agent-identities","href":"/api-reference/all-endpoints/settings/list-agent-identity-records-—-inventory-of-every-orbit-ai-agent-as-a-non-human-identity"},{"title":"Bulk decommission agent identities — suspend many (or all) agents in one action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/agent-identities/bulk-suspend","href":"/api-reference/all-endpoints/settings/bulk-decommission-agent-identities-—-suspend-many-or-all-agents-in-one-action"},{"title":"Get the SAML configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/saml","href":"/api-reference/all-endpoints/settings/get-the-saml-configuration"},{"title":"Configure SAML SSO","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/saml","href":"/api-reference/all-endpoints/settings/configure-saml-sso"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/saml/health","href":"/api-reference/all-endpoints/settings/list-health"},{"title":"Parse-certificate saml","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/saml/parse-certificate","href":"/api-reference/all-endpoints/settings/parse-certificate-saml"},{"title":"Probe the IdP metadata URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/saml/test-connection","href":"/api-reference/all-endpoints/settings/probe-the-idp-metadata-url"},{"title":"Get the SCIM configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/scim","href":"/api-reference/all-endpoints/settings/get-the-scim-configuration"},{"title":"Update the SCIM configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/settings/scim","href":"/api-reference/all-endpoints/settings/update-the-scim-configuration"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/settings/scim/health","href":"/api-reference/all-endpoints/settings/list-health-1"},{"title":"Test-connection scim","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/scim/test-connection","href":"/api-reference/all-endpoints/settings/test-connection-scim"},{"title":"Rotate the SCIM Bearer token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/settings/scim/generate-token","href":"/api-reference/all-endpoints/settings/rotate-the-scim-bearer-token"}]},{"group":"Contacts","pages":[{"title":"Count potential duplicate contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/duplicates/count","href":"/api-reference/all-endpoints/contacts/count-potential-duplicate-contacts"},{"title":"List duplicate contact groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/duplicates","href":"/api-reference/all-endpoints/contacts/list-duplicate-contact-groups"},{"title":"Merge duplicate contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/merge","href":"/api-reference/all-endpoints/contacts/merge-duplicate-contacts"},{"title":"Unmerge contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/unmerge/{mergeId}","href":"/api-reference/all-endpoints/contacts/unmerge-contacts"},{"title":"Get CRM context for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/crm-context","href":"/api-reference/all-endpoints/contacts/get-crm-context-for-a-contact"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts","href":"/api-reference/all-endpoints/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts","href":"/api-reference/all-endpoints/contacts/create-a-contact"},{"title":"Bulk import contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk","href":"/api-reference/all-endpoints/contacts/bulk-import-contacts"},{"title":"List recent contact import jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/import-jobs","href":"/api-reference/all-endpoints/contacts/list-recent-contact-import-jobs"},{"title":"Download skipped-rows CSV for a contact import job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/import-jobs/{id}/skipped.csv","href":"/api-reference/all-endpoints/contacts/download-skipped-rows-csv-for-a-contact-import-job"},{"title":"Preview a contact import (dry run)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/imports/preview","href":"/api-reference/all-endpoints/contacts/preview-a-contact-import-dry-run"},{"title":"Enqueue an asynchronous contact import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/imports","href":"/api-reference/all-endpoints/contacts/enqueue-an-asynchronous-contact-import"},{"title":"Get contact import job status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/imports/{id}","href":"/api-reference/all-endpoints/contacts/get-contact-import-job-status"},{"title":"Cancel a running contact import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/imports/{id}/cancel","href":"/api-reference/all-endpoints/contacts/cancel-a-running-contact-import"},{"title":"Roll back a completed contact import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/imports/{id}/rollback","href":"/api-reference/all-endpoints/contacts/roll-back-a-completed-contact-import"},{"title":"Bulk delete contacts (soft delete)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk-delete","href":"/api-reference/all-endpoints/contacts/bulk-delete-contacts-soft-delete"},{"title":"Bulk contact actions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/actions","href":"/api-reference/all-endpoints/contacts/bulk-contact-actions"},{"title":"Export contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/export","href":"/api-reference/all-endpoints/contacts/export-contacts"},{"title":"Get aggregate contact stats for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/stats","href":"/api-reference/all-endpoints/contacts/get-aggregate-contact-stats-for-the-tenant"},{"title":"List lifecycle","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/stats/lifecycle","href":"/api-reference/all-endpoints/contacts/list-lifecycle"},{"title":"Scan for duplicate contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/duplicates/scan","href":"/api-reference/all-endpoints/contacts/scan-for-duplicate-contacts"},{"title":"List opted-out contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/optouts","href":"/api-reference/all-endpoints/contacts/list-opted-out-contacts"},{"title":"Opt a contact out of a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/optouts","href":"/api-reference/all-endpoints/contacts/opt-a-contact-out-of-a-channel"},{"title":"Bulk opt contacts out","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/optouts/bulk","href":"/api-reference/all-endpoints/contacts/bulk-opt-contacts-out"},{"title":"Export opted-out contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/optouts/export","href":"/api-reference/all-endpoints/contacts/export-opted-out-contacts"},{"title":"Re-opt a contact in for a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/optouts/{id}/{channel}","href":"/api-reference/all-endpoints/contacts/re-opt-a-contact-in-for-a-channel"},{"title":"Get a contact by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}","href":"/api-reference/all-endpoints/contacts/get-a-contact-by-id"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/contacts/{id}","href":"/api-reference/all-endpoints/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{id}","href":"/api-reference/all-endpoints/contacts/delete-a-contact"},{"title":"List activity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/activity","href":"/api-reference/all-endpoints/contacts/list-activity"},{"title":"Get a contact's predictive scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/scores","href":"/api-reference/all-endpoints/contacts/get-a-contacts-predictive-scores"},{"title":"Get a contact's engagement profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/engagement","href":"/api-reference/all-endpoints/contacts/get-a-contacts-engagement-profile"},{"title":"Predictive next-best-action suggestions for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/next-best-action","href":"/api-reference/all-endpoints/contacts/predictive-next-best-action-suggestions-for-a-contact"},{"title":"List channel-state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/channel-state","href":"/api-reference/all-endpoints/contacts/list-channel-state"},{"title":"Export customer events (NDJSON stream)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/events/export","href":"/api-reference/all-endpoints/contacts/export-customer-events-ndjson-stream"},{"title":"List channel-recommendations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/channel-recommendations","href":"/api-reference/all-endpoints/contacts/list-channel-recommendations"},{"title":"Create channel-recommendations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/channel-recommendations","href":"/api-reference/all-endpoints/contacts/create-channel-recommendations"},{"title":"List contact predictive scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/scores","href":"/api-reference/all-endpoints/contacts/list-contact-predictive-scores"},{"title":"Get contact-score segment histogram","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/scores/histogram","href":"/api-reference/all-endpoints/contacts/get-contact-score-segment-histogram"},{"title":"Customer 360 unified profile for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/profile","href":"/api-reference/all-endpoints/contacts/customer-360-unified-profile-for-a-contact"},{"title":"Lightweight contact preview for the inbox hover-card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/preview","href":"/api-reference/all-endpoints/contacts/lightweight-contact-preview-for-the-inbox-hover-card"},{"title":"Unified customer-journey timeline for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/journey","href":"/api-reference/all-endpoints/contacts/unified-customer-journey-timeline-for-a-contact"},{"title":"Unified chronological contact timeline (messages + calls + tickets + events)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/timeline","href":"/api-reference/all-endpoints/contacts/unified-chronological-contact-timeline-messages-+-calls-+-tickets-+-events"},{"title":"Export the contact journey timeline as CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/journey.csv","href":"/api-reference/all-endpoints/contacts/export-the-contact-journey-timeline-as-csv"},{"title":"List notes for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/notes","href":"/api-reference/all-endpoints/contacts/list-notes-for-a-contact"},{"title":"Create a note on a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/notes","href":"/api-reference/all-endpoints/contacts/create-a-note-on-a-contact"},{"title":"Delete a contact note","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{id}/notes/{noteId}","href":"/api-reference/all-endpoints/contacts/delete-a-contact-note"},{"title":"Update a contact note","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/contacts/{id}/notes/{noteId}","href":"/api-reference/all-endpoints/contacts/update-a-contact-note"},{"title":"Block a contact. Inbound messages auto-route to Spam; outbound is rejected.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/block","href":"/api-reference/all-endpoints/contacts/block-a-contact-inbound-messages-auto-route-to-spam;-outbound-is-rejected"},{"title":"Unblock a contact.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/unblock","href":"/api-reference/all-endpoints/contacts/unblock-a-contact"},{"title":"List currently-blocked contacts (audit #INX-F-011).","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/blocked","href":"/api-reference/all-endpoints/contacts/list-currently-blocked-contacts-audit-#inx-f-011"},{"title":"Get tri-state consent preferences (opted_in | opted_out | unknown) per channel for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/preferences","href":"/api-reference/all-endpoints/contacts/get-tri-state-consent-preferences-opted_in-|-opted_out-|-unknown-per-channel-for-a-contact"},{"title":"Update a contact's channel consent preferences","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/contacts/{id}/preferences","href":"/api-reference/all-endpoints/contacts/update-a-contacts-channel-consent-preferences"},{"title":"Get the enabled frequency-cap config rule rows (grouped_by_channel + global_caps) that apply to a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/frequency-caps","href":"/api-reference/all-endpoints/contacts/get-the-enabled-frequency-cap-config-rule-rows-grouped_by_channel-+-global_caps-that-apply-to-a-contact"},{"title":"Export a contact's personal data (GDPR DSAR)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/gdpr/export","href":"/api-reference/all-endpoints/contacts/export-a-contacts-personal-data-gdpr-dsar"},{"title":"Preview the data impact of a GDPR erasure/export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/gdpr/preview","href":"/api-reference/all-endpoints/contacts/preview-the-data-impact-of-a-gdpr-erasureexport"},{"title":"Mint a re-auth challenge for GDPR deletion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/gdpr/delete/challenge","href":"/api-reference/all-endpoints/contacts/mint-a-re-auth-challenge-for-gdpr-deletion"},{"title":"Delete all of a contact's data (GDPR right-to-erasure)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{id}/gdpr/delete","href":"/api-reference/all-endpoints/contacts/delete-all-of-a-contacts-data-gdpr-right-to-erasure"},{"title":"File a GDPR right-to-erasure request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/gdpr/erasure-request","href":"/api-reference/all-endpoints/contacts/file-a-gdpr-right-to-erasure-request"},{"title":"List a contact's GDPR erasure requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/gdpr/erasure-requests","href":"/api-reference/all-endpoints/contacts/list-a-contacts-gdpr-erasure-requests"},{"title":"Cancel a pending GDPR erasure request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/gdpr/erasure-request/{requestId}/cancel","href":"/api-reference/all-endpoints/contacts/cancel-a-pending-gdpr-erasure-request"},{"title":"Add tags to a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/tags","href":"/api-reference/all-endpoints/contacts/add-tags-to-a-contact"},{"title":"Remove a tag from a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{id}/tags/{tag}","href":"/api-reference/all-endpoints/contacts/remove-a-tag-from-a-contact"},{"title":"List consent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/consent","href":"/api-reference/all-endpoints/contacts/list-consent"},{"title":"Record consent for a contact on a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/{id}/consent","href":"/api-reference/all-endpoints/contacts/record-consent-for-a-contact-on-a-channel"},{"title":"Delete consent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{id}/consent/{channel}","href":"/api-reference/all-endpoints/contacts/delete-consent"},{"title":"Deliverability health for a contact on one channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/deliverability-health","href":"/api-reference/all-endpoints/contacts/deliverability-health-for-a-contact-on-one-channel"},{"title":"List cap-status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/cap-status","href":"/api-reference/all-endpoints/contacts/list-cap-status"},{"title":"Get contact-list stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/lists/stats","href":"/api-reference/all-endpoints/contacts/get-contact-list-stats"},{"title":"List contact lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/lists","href":"/api-reference/all-endpoints/contacts/list-contact-lists"},{"title":"Create a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/lists","href":"/api-reference/all-endpoints/contacts/create-a-contact-list"},{"title":"Update a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/contacts/lists/{id}","href":"/api-reference/all-endpoints/contacts/update-a-contact-list"},{"title":"Delete a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/lists/{id}","href":"/api-reference/all-endpoints/contacts/delete-a-contact-list"},{"title":"Duplicate a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/lists/{id}/duplicate","href":"/api-reference/all-endpoints/contacts/duplicate-a-contact-list"},{"title":"List members of a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/lists/{id}/members","href":"/api-reference/all-endpoints/contacts/list-members-of-a-contact-list"},{"title":"Add a contact to a list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/lists/{id}/members","href":"/api-reference/all-endpoints/contacts/add-a-contact-to-a-list"},{"title":"Remove a contact from a list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/lists/{id}/members/{memberId}","href":"/api-reference/all-endpoints/contacts/remove-a-contact-from-a-list"},{"title":"List the lists a contact belongs to","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/lists","href":"/api-reference/all-endpoints/contacts/list-the-lists-a-contact-belongs-to"},{"title":"Enrich contacts (bulk)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/enrich","href":"/api-reference/all-endpoints/contacts/enrich-contacts-bulk"},{"title":"List duplicates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/duplicates","href":"/api-reference/all-endpoints/contacts/list-duplicates"},{"title":"List contact merge history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/merge-history","href":"/api-reference/all-endpoints/contacts/list-contact-merge-history"},{"title":"List the segments a contact belongs to","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/segments","href":"/api-reference/all-endpoints/contacts/list-the-segments-a-contact-belongs-to"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/{id}/campaigns","href":"/api-reference/all-endpoints/contacts/list-campaigns"},{"title":"Add multiple contacts to a list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/lists/{id}/members/bulk","href":"/api-reference/all-endpoints/contacts/add-multiple-contacts-to-a-list"},{"title":"List a tenant's contact segments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments","href":"/api-reference/all-endpoints/contacts/list-a-tenants-contact-segments"},{"title":"Create a contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments","href":"/api-reference/all-endpoints/contacts/create-a-contact-segment"},{"title":"Get authoritative per-tenant segment totals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/stats","href":"/api-reference/all-endpoints/contacts/get-authoritative-per-tenant-segment-totals"},{"title":"Get a single contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}","href":"/api-reference/all-endpoints/contacts/get-a-single-contact-segment"},{"title":"Update a contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/contacts/segments/{id}","href":"/api-reference/all-endpoints/contacts/update-a-contact-segment"},{"title":"Delete a contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/segments/{id}","href":"/api-reference/all-endpoints/contacts/delete-a-contact-segment"},{"title":"Deliverability-health rollup for a contact segment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/deliverability-health","href":"/api-reference/all-endpoints/contacts/deliverability-health-rollup-for-a-contact-segment"},{"title":"Re-evaluate a segment and rebuild its membership","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/evaluate","href":"/api-reference/all-endpoints/contacts/re-evaluate-a-segment-and-rebuild-its-membership"},{"title":"Manually refresh a segment's membership","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/refresh","href":"/api-reference/all-endpoints/contacts/manually-refresh-a-segments-membership"},{"title":"Preview an AI lookalike expansion of a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/expand","href":"/api-reference/all-endpoints/contacts/preview-an-ai-lookalike-expansion-of-a-segment"},{"title":"Materialize a lookalike preview into a static segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/materialize-lookalike","href":"/api-reference/all-endpoints/contacts/materialize-a-lookalike-preview-into-a-static-segment"},{"title":"List a segment's members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/members","href":"/api-reference/all-endpoints/contacts/list-a-segments-members"},{"title":"Get a segment's audience-size history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/size-history","href":"/api-reference/all-endpoints/contacts/get-a-segments-audience-size-history"},{"title":"Segment performance \u0026 ROI (spend vs attributed revenue)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/performance","href":"/api-reference/all-endpoints/contacts/segment-performance-\u0026-roi-spend-vs-attributed-revenue"},{"title":"List a segment's point-in-time audience snapshots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/snapshots","href":"/api-reference/all-endpoints/contacts/list-a-segments-point-in-time-audience-snapshots"},{"title":"Freeze a segment's membership as a point-in-time snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/snapshots","href":"/api-reference/all-endpoints/contacts/freeze-a-segments-membership-as-a-point-in-time-snapshot"},{"title":"Diff cohort drift between two segment snapshots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/snapshots/diff","href":"/api-reference/all-endpoints/contacts/diff-cohort-drift-between-two-segment-snapshots"},{"title":"List the frozen membership of one segment snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/snapshots/{snapshotId}/members","href":"/api-reference/all-endpoints/contacts/list-the-frozen-membership-of-one-segment-snapshot"},{"title":"List a segment's rule-definition version history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/definition-history","href":"/api-reference/all-endpoints/contacts/list-a-segments-rule-definition-version-history"},{"title":"Revert a segment to a prior rule definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/{id}/definition-history/{versionId}/revert","href":"/api-reference/all-endpoints/contacts/revert-a-segment-to-a-prior-rule-definition"},{"title":"Export a segment's members as CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/segments/{id}/export.csv","href":"/api-reference/all-endpoints/contacts/export-a-segments-members-as-csv"},{"title":"Preview an unsaved segment filter","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/preview","href":"/api-reference/all-endpoints/contacts/preview-an-unsaved-segment-filter"},{"title":"Estimate an unsaved segment's audience size","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/estimate","href":"/api-reference/all-endpoints/contacts/estimate-an-unsaved-segments-audience-size"},{"title":"Create a segment from a natural-language prompt (AI)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/from-prompt","href":"/api-reference/all-endpoints/contacts/create-a-segment-from-a-natural-language-prompt-ai"},{"title":"Suggest segment rules from a prompt (AI, no persist)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/suggest-rules","href":"/api-reference/all-endpoints/contacts/suggest-segment-rules-from-a-prompt-ai-no-persist"},{"title":"Analyse audience overlap across segments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/overlap","href":"/api-reference/all-endpoints/contacts/analyse-audience-overlap-across-segments"},{"title":"Delete memory","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/contacts/{contactId}/memory","href":"/api-reference/all-endpoints/contacts/delete-memory"},{"title":"Unified contact snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/customer-360/contacts/{id}/snapshot","href":"/api-reference/all-endpoints/contacts/unified-contact-snapshot"},{"title":"Bulk add/remove tags on contacts by selector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/tag","href":"/api-reference/all-endpoints/contacts/bulk-addremove-tags-on-contacts-by-selector"},{"title":"Bulk add/remove contacts to a segment by selector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/segment","href":"/api-reference/all-endpoints/contacts/bulk-addremove-contacts-to-a-segment-by-selector"},{"title":"Bulk soft-delete contacts by selector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/delete","href":"/api-reference/all-endpoints/contacts/bulk-soft-delete-contacts-by-selector"},{"title":"Start a background contacts export by selector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/export","href":"/api-reference/all-endpoints/contacts/start-a-background-contacts-export-by-selector"},{"title":"Send an ad-hoc broadcast to a selected audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/send","href":"/api-reference/all-endpoints/contacts/send-an-ad-hoc-broadcast-to-a-selected-audience"},{"title":"Bulk update contact properties by selector","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/bulk/update-properties","href":"/api-reference/all-endpoints/contacts/bulk-update-contact-properties-by-selector"},{"title":"Poll a bulk contact operation's progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/bulk/jobs/{id}","href":"/api-reference/all-endpoints/contacts/poll-a-bulk-contact-operations-progress"},{"title":"Download a background contacts export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/contacts/bulk/exports/{id}/download","href":"/api-reference/all-endpoints/contacts/download-a-background-contacts-export"}]},{"group":"Segments","pages":[{"title":"Build a segment from a natural-language description (AI)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/contacts/segments/autopilot","href":"/api-reference/all-endpoints/segments/build-a-segment-from-a-natural-language-description-ai"},{"title":"Auto-suggest segments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/segments/auto-suggest","href":"/api-reference/all-endpoints/segments/auto-suggest-segments"},{"title":"Export an ad-hoc audience as CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/segments/export.csv","href":"/api-reference/all-endpoints/segments/export-an-ad-hoc-audience-as-csv"},{"title":"Build a clicked-cohort segment from tracked link clicks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/segments/from-clicks","href":"/api-reference/all-endpoints/segments/build-a-clicked-cohort-segment-from-tracked-link-clicks"}]},{"group":"Billing","pages":[{"title":"Receive Stripe billing webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/webhooks/stripe","href":"/api-reference/all-endpoints/billing/receive-stripe-billing-webhooks"},{"title":"Receive NOWPayments crypto top-up IPNs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/webhooks/nowpayments","href":"/api-reference/all-endpoints/billing/receive-nowpayments-crypto-top-up-ipns"},{"title":"Receive Orb usage-billing webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/webhooks/orb","href":"/api-reference/all-endpoints/billing/receive-orb-usage-billing-webhooks"},{"title":"Report AI agent usage","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/agent-usage","href":"/api-reference/all-endpoints/billing/report-ai-agent-usage"},{"title":"Charge a wallet for an eSIM order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/esim-charge","href":"/api-reference/all-endpoints/billing/charge-a-wallet-for-an-esim-order"},{"title":"Refund an eSIM order charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/esim-refund","href":"/api-reference/all-endpoints/billing/refund-an-esim-order-charge"},{"title":"Billing provider configuration status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/status","href":"/api-reference/all-endpoints/billing/billing-provider-configuration-status"},{"title":"List self-serve plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/plans","href":"/api-reference/all-endpoints/billing/list-self-serve-plans"},{"title":"Live snapshot of the organization's subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/subscription","href":"/api-reference/all-endpoints/billing/live-snapshot-of-the-organizations-subscription"},{"title":"Cancel, reactivate, or change the subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/subscription","href":"/api-reference/all-endpoints/billing/cancel-reactivate-or-change-the-subscription"},{"title":"Create a plan checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/checkout","href":"/api-reference/all-endpoints/billing/create-a-plan-checkout-session"},{"title":"Create a billing portal session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/portal","href":"/api-reference/all-endpoints/billing/create-a-billing-portal-session"},{"title":"Create a pay-by-link request-to-pay","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/pay-by-link","href":"/api-reference/all-endpoints/billing/create-a-pay-by-link-request-to-pay"},{"title":"Preview a pay-by-link message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/pay-by-link/preview","href":"/api-reference/all-endpoints/billing/preview-a-pay-by-link-message"},{"title":"Get current-period usage metrics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/usage","href":"/api-reference/all-endpoints/billing/get-current-period-usage-metrics"},{"title":"Usage cost and volume by channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/usage-by-channel","href":"/api-reference/all-endpoints/billing/usage-cost-and-volume-by-channel"},{"title":"Get the cost-center chargeback rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/chargeback-rollup","href":"/api-reference/all-endpoints/billing/get-the-cost-center-chargeback-rollup"},{"title":"Get the monthly budget cap status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/budget-cap","href":"/api-reference/all-endpoints/billing/get-the-monthly-budget-cap-status"},{"title":"Get your account balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/balance","href":"/api-reference/all-endpoints/billing/get-your-account-balance"},{"title":"Top up your prepaid balance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/balance/top-up","href":"/api-reference/all-endpoints/billing/top-up-your-prepaid-balance"},{"title":"Start a crypto top-up","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/balance/top-up-crypto","href":"/api-reference/all-endpoints/billing/start-a-crypto-top-up"},{"title":"Check a crypto top-up status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/crypto-topup/{intentId}/status","href":"/api-reference/all-endpoints/billing/check-a-crypto-top-up-status"},{"title":"Cancel a pending crypto top-up","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/crypto-topup/{intentId}/cancel","href":"/api-reference/all-endpoints/billing/cancel-a-pending-crypto-top-up"},{"title":"Get your credits balance (balance alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/credits","href":"/api-reference/all-endpoints/billing/get-your-credits-balance-balance-alias"},{"title":"Purchase credits by card (top-up alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/credits/purchase","href":"/api-reference/all-endpoints/billing/purchase-credits-by-card-top-up-alias"},{"title":"Confirm a card credit purchase","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/credits/confirm","href":"/api-reference/all-endpoints/billing/confirm-a-card-credit-purchase"},{"title":"Get the default payment method","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/payment-method","href":"/api-reference/all-endpoints/billing/get-the-default-payment-method"},{"title":"Get auto-top-up configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/auto-topup","href":"/api-reference/all-endpoints/billing/get-auto-top-up-configuration"},{"title":"Update auto-top-up configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/billing/auto-topup","href":"/api-reference/all-endpoints/billing/update-auto-top-up-configuration"},{"title":"Disable auto-top-up","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/billing/auto-topup","href":"/api-reference/all-endpoints/billing/disable-auto-top-up"},{"title":"Get outcome-billing configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/outcome-pricing","href":"/api-reference/all-endpoints/billing/get-outcome-billing-configuration"},{"title":"Update outcome-billing configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/billing/outcome-pricing","href":"/api-reference/all-endpoints/billing/update-outcome-billing-configuration"},{"title":"Get spend burn rate and projection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/burn-rate","href":"/api-reference/all-endpoints/billing/get-spend-burn-rate-and-projection"},{"title":"List wallet ledger transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/transactions","href":"/api-reference/all-endpoints/billing/list-wallet-ledger-transactions"},{"title":"Daily spend series with projection and anomaly flags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/spend-series","href":"/api-reference/all-endpoints/billing/daily-spend-series-with-projection-and-anomaly-flags"},{"title":"Get the committed-use drawdown meter","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/commitment","href":"/api-reference/all-endpoints/billing/get-the-committed-use-drawdown-meter"},{"title":"Per-contract revenue-recognition schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/revenue-recognition/schedule","href":"/api-reference/all-endpoints/billing/per-contract-revenue-recognition-schedule"},{"title":"Recognized vs deferred revenue rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/revenue-recognition/summary","href":"/api-reference/all-endpoints/billing/recognized-vs-deferred-revenue-rollup"},{"title":"Preview volume-discount pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/volume-tier-preview","href":"/api-reference/all-endpoints/billing/preview-volume-discount-pricing"},{"title":"Preview aiaas-usage-pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/aiaas-usage-pricing/preview","href":"/api-reference/all-endpoints/billing/preview-aiaas-usage-pricing"},{"title":"Preview the marketplace rev-share split","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/marketplace-rev-share/preview","href":"/api-reference/all-endpoints/billing/preview-the-marketplace-rev-share-split"},{"title":"Preview resolution-usage billing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/resolution-usage-meter/preview","href":"/api-reference/all-endpoints/billing/preview-resolution-usage-billing"},{"title":"Preview the reseller margin rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/margin-rollup/preview","href":"/api-reference/all-endpoints/billing/preview-the-reseller-margin-rollup"},{"title":"Preview a partner payout ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/payout-ledger/preview","href":"/api-reference/all-endpoints/billing/preview-a-partner-payout-ledger"},{"title":"Replay real usage against a candidate rate card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/whatif-pricing/preview","href":"/api-reference/all-endpoints/billing/replay-real-usage-against-a-candidate-rate-card"},{"title":"Flag channels with surging spend velocity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/spend-anomaly","href":"/api-reference/all-endpoints/billing/flag-channels-with-surging-spend-velocity"},{"title":"Historical spend-anomaly ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/spend-anomaly/ledger","href":"/api-reference/all-endpoints/billing/historical-spend-anomaly-ledger"},{"title":"Wire a spend anomaly into on-call escalation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/spend-anomaly/escalation","href":"/api-reference/all-endpoints/billing/wire-a-spend-anomaly-into-on-call-escalation"},{"title":"Seat-tier breakdown and savings estimate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/seats","href":"/api-reference/all-endpoints/billing/seat-tier-breakdown-and-savings-estimate"},{"title":"Flip a user between full and light seats","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/billing/seats/{userId}","href":"/api-reference/all-endpoints/billing/flip-a-user-between-full-and-light-seats"},{"title":"List credit refunds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/refunds","href":"/api-reference/all-endpoints/billing/list-credit-refunds"},{"title":"Create a credit refund","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/refunds","href":"/api-reference/all-endpoints/billing/create-a-credit-refund"},{"title":"Get a credit refund","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/refunds/{id}","href":"/api-reference/all-endpoints/billing/get-a-credit-refund"},{"title":"Check trial-credit grant status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/trial-credits/status","href":"/api-reference/all-endpoints/billing/check-trial-credit-grant-status"},{"title":"Grant the one-time trial credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/trial-credits","href":"/api-reference/all-endpoints/billing/grant-the-one-time-trial-credit"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/invoices","href":"/api-reference/all-endpoints/billing/list-invoices"},{"title":"Get the in-progress invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/invoices/upcoming","href":"/api-reference/all-endpoints/billing/get-the-in-progress-invoice"},{"title":"Get one invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/invoices/{id}","href":"/api-reference/all-endpoints/billing/get-one-invoice"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/invoices/{id}/download","href":"/api-reference/all-endpoints/billing/download-an-invoice-pdf"},{"title":"List monthly wallet statements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/statements","href":"/api-reference/all-endpoints/billing/list-monthly-wallet-statements"},{"title":"Monthly statement detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/statements/{period}","href":"/api-reference/all-endpoints/billing/monthly-statement-detail"},{"title":"Download a monthly statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/statements/{period}/download","href":"/api-reference/all-endpoints/billing/download-a-monthly-statement"},{"title":"List volume-discount tiers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/volume-tiers","href":"/api-reference/all-endpoints/billing/list-volume-discount-tiers"},{"title":"Create a volume-discount tier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/volume-tiers","href":"/api-reference/all-endpoints/billing/create-a-volume-discount-tier"},{"title":"Delete a volume tier","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/billing/volume-tiers/{id}","href":"/api-reference/all-endpoints/billing/delete-a-volume-tier"},{"title":"Update a volume tier","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/billing/volume-tiers/{id}","href":"/api-reference/all-endpoints/billing/update-a-volume-tier"},{"title":"List the MCC/MNC network catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/mccmnc-overrides/mnc-list","href":"/api-reference/all-endpoints/billing/list-the-mccmnc-network-catalog"},{"title":"List MCCMNC rate overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/mccmnc-overrides","href":"/api-reference/all-endpoints/billing/list-mccmnc-rate-overrides"},{"title":"Create an MCCMNC rate override","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/mccmnc-overrides","href":"/api-reference/all-endpoints/billing/create-an-mccmnc-rate-override"},{"title":"Delete an MCCMNC rate override","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/billing/mccmnc-overrides/{id}","href":"/api-reference/all-endpoints/billing/delete-an-mccmnc-rate-override"},{"title":"Update an MCCMNC rate override","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/billing/mccmnc-overrides/{id}","href":"/api-reference/all-endpoints/billing/update-an-mccmnc-rate-override"},{"title":"List billing alerts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/alerts","href":"/api-reference/all-endpoints/billing/list-billing-alerts"},{"title":"Create a billing alert","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/alerts","href":"/api-reference/all-endpoints/billing/create-a-billing-alert"},{"title":"Get a billing alert","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/billing/alerts/{id}","href":"/api-reference/all-endpoints/billing/get-a-billing-alert"},{"title":"Delete a billing alert","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/billing/alerts/{id}","href":"/api-reference/all-endpoints/billing/delete-a-billing-alert"},{"title":"Update a billing alert","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/billing/alerts/{id}","href":"/api-reference/all-endpoints/billing/update-a-billing-alert"},{"title":"Test-fire a billing alert","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/alerts/{id}/test-fire","href":"/api-reference/all-endpoints/billing/test-fire-a-billing-alert"},{"title":"Reset outbound pause and block flags","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/billing/alerts/reset-outbound","href":"/api-reference/all-endpoints/billing/reset-outbound-pause-and-block-flags"}]},{"group":"Analytics","pages":[{"title":"Conversation intelligence analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/conversation-intelligence","href":"/api-reference/all-endpoints/analytics/conversation-intelligence-analytics"},{"title":"Dashboard summary cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/summary","href":"/api-reference/all-endpoints/analytics/dashboard-summary-cards"},{"title":"Per-channel operational health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/channel-health","href":"/api-reference/all-endpoints/analytics/per-channel-operational-health"},{"title":"Per-day usage timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/usage","href":"/api-reference/all-endpoints/analytics/per-day-usage-timeline"},{"title":"Recent activity feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/activity","href":"/api-reference/all-endpoints/analytics/recent-activity-feed"},{"title":"API request logs for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/request-logs","href":"/api-reference/all-endpoints/analytics/api-request-logs-for-the-tenant"},{"title":"Unified home-overview dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/dashboard","href":"/api-reference/all-endpoints/analytics/unified-home-overview-dashboard"},{"title":"SMS channel statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/sms","href":"/api-reference/all-endpoints/analytics/sms-channel-statistics"},{"title":"SMS gateway operational health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/gateway/sms","href":"/api-reference/all-endpoints/analytics/sms-gateway-operational-health"},{"title":"WhatsApp channel statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/whatsapp","href":"/api-reference/all-endpoints/analytics/whatsapp-channel-statistics"},{"title":"Agent and conversation statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/agents","href":"/api-reference/all-endpoints/analytics/agent-and-conversation-statistics"},{"title":"Contact count and growth statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/contacts","href":"/api-reference/all-endpoints/analytics/contact-count-and-growth-statistics"},{"title":"Voice call statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/voice","href":"/api-reference/all-endpoints/analytics/voice-call-statistics"},{"title":"Phone number inventory statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/numbers","href":"/api-reference/all-endpoints/analytics/phone-number-inventory-statistics"},{"title":"Flow execution statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/flows","href":"/api-reference/all-endpoints/analytics/flow-execution-statistics"},{"title":"Advanced message analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics","href":"/api-reference/all-endpoints/analytics/advanced-message-analytics"},{"title":"Analytics summary for the window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/summary","href":"/api-reference/all-endpoints/analytics/analytics-summary-for-the-window"},{"title":"Per-channel analytics breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/channels","href":"/api-reference/all-endpoints/analytics/per-channel-analytics-breakdown"},{"title":"Daily message volume timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/volume","href":"/api-reference/all-endpoints/analytics/daily-message-volume-timeline"},{"title":"Delivery funnel for the window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/delivery","href":"/api-reference/all-endpoints/analytics/delivery-funnel-for-the-window"},{"title":"Aggregate message delivery metrics with time series","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messages","href":"/api-reference/all-endpoints/analytics/aggregate-message-delivery-metrics-with-time-series"},{"title":"Delivery metrics broken down by channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messages/by-channel","href":"/api-reference/all-endpoints/analytics/delivery-metrics-broken-down-by-channel"},{"title":"Delivery metrics broken down by destination country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messages/by-country","href":"/api-reference/all-endpoints/analytics/delivery-metrics-broken-down-by-destination-country"},{"title":"Message failure analysis by carrier error code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messages/errors","href":"/api-reference/all-endpoints/analytics/message-failure-analysis-by-carrier-error-code"},{"title":"Cost analytics with time-series and channel breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/costs","href":"/api-reference/all-endpoints/analytics/cost-analytics-with-time-series-and-channel-breakdown"},{"title":"Estimated CO2e footprint per channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/carbon","href":"/api-reference/all-endpoints/analytics/estimated-co2e-footprint-per-channel"},{"title":"Download a CSV carbon sustainability report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/carbon/export","href":"/api-reference/all-endpoints/analytics/download-a-csv-carbon-sustainability-report"},{"title":"Carrier rejection codes behind a funnel drop-off","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/funnel/{step}/drop-reasons","href":"/api-reference/all-endpoints/analytics/carrier-rejection-codes-behind-a-funnel-drop-off"},{"title":"Telegram-specific KPIs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/telegram","href":"/api-reference/all-endpoints/analytics/telegram-specific-kpis"},{"title":"Per-channel deliverability dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/deliverability","href":"/api-reference/all-endpoints/analytics/per-channel-deliverability-dashboard"},{"title":"Compare your rates against cross-tenant benchmark cohorts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/benchmarks","href":"/api-reference/all-endpoints/analytics/compare-your-rates-against-cross-tenant-benchmark-cohorts"},{"title":"Messaging insights — carrier, country, and error breakdowns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messaging-insights","href":"/api-reference/all-endpoints/analytics/messaging-insights-—-carrier-country-and-error-breakdowns"},{"title":"Per-carrier (MNO) delivery truth with silent-drop inference","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/per-mno-delivery","href":"/api-reference/all-endpoints/analytics/per-carrier-mno-delivery-truth-with-silent-drop-inference"},{"title":"Top conversations by telco cost-to-serve","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/cost-per-conversation","href":"/api-reference/all-endpoints/analytics/top-conversations-by-telco-cost-to-serve"},{"title":"Per-carrier-connector (route-level) delivery breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/per-route-delivery","href":"/api-reference/all-endpoints/analytics/per-carrier-connector-route-level-delivery-breakdown"},{"title":"Per-route DLR-rate anomaly classification (drop/normal/insufficient_data)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/route-dlr-anomaly","href":"/api-reference/all-endpoints/analytics/per-route-dlr-rate-anomaly-classification-dropnormalinsufficient_data"},{"title":"Per-route delivery-latency + silent-failure SLO status (ok/breach/insufficient_data)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/route-latency-slo","href":"/api-reference/all-endpoints/analytics/per-route-delivery-latency-+-silent-failure-slo-status-okbreachinsufficient_data"},{"title":"Aggregate usage \u0026 delivery anomaly snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/usage-anomalies","href":"/api-reference/all-endpoints/analytics/aggregate-usage-\u0026-delivery-anomaly-snapshot"},{"title":"Per-queue/campaign outbound delivery funnel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/delivery-waterfall","href":"/api-reference/all-endpoints/analytics/per-queuecampaign-outbound-delivery-funnel"},{"title":"SMS click-through reporting parity panel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/sms-click-through","href":"/api-reference/all-endpoints/analytics/sms-click-through-reporting-parity-panel"},{"title":"Account-level messaging health score","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/messaging-health-score","href":"/api-reference/all-endpoints/analytics/account-level-messaging-health-score"},{"title":"Cross-channel deliverability and sender-reputation cockpit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/deliverability-health-center","href":"/api-reference/all-endpoints/analytics/cross-channel-deliverability-and-sender-reputation-cockpit"},{"title":"Portfolio-level conversation sentiment analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/sentiment","href":"/api-reference/all-endpoints/analytics/portfolio-level-conversation-sentiment-analytics"},{"title":"Aggregated contact-reason volume analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/contact-reasons","href":"/api-reference/all-endpoints/analytics/aggregated-contact-reason-volume-analytics"},{"title":"Cross-channel topic \u0026 contact-reason intelligence","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/topic-intelligence","href":"/api-reference/all-endpoints/analytics/cross-channel-topic-\u0026-contact-reason-intelligence"},{"title":"Cross-channel customer-journey path (Sankey) analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/journey-paths","href":"/api-reference/all-endpoints/analytics/cross-channel-customer-journey-path-sankey-analytics"},{"title":"Multi-touch marketing attribution (first/last/linear model picker)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/attribution","href":"/api-reference/all-endpoints/analytics/multi-touch-marketing-attribution-firstlastlinear-model-picker"},{"title":"List scheduled analytics reports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/scheduled-reports","href":"/api-reference/all-endpoints/analytics/list-scheduled-analytics-reports"},{"title":"Create a scheduled analytics report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/scheduled-reports","href":"/api-reference/all-endpoints/analytics/create-a-scheduled-analytics-report"},{"title":"Delete a scheduled analytics report","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/analytics/scheduled-reports/{id}","href":"/api-reference/all-endpoints/analytics/delete-a-scheduled-analytics-report"},{"title":"Update a scheduled analytics report","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/analytics/scheduled-reports/{id}","href":"/api-reference/all-endpoints/analytics/update-a-scheduled-analytics-report"},{"title":"Send a scheduled report immediately","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/scheduled-reports/{id}/send-now","href":"/api-reference/all-endpoints/analytics/send-a-scheduled-report-immediately"},{"title":"List the widget catalog for custom dashboards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/dashboards/widgets","href":"/api-reference/all-endpoints/analytics/list-the-widget-catalog-for-custom-dashboards"},{"title":"Validate and normalise a dashboard layout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/dashboards/validate","href":"/api-reference/all-endpoints/analytics/validate-and-normalise-a-dashboard-layout"},{"title":"Resolve a plain-English question to a governed widget","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/copilot/ask","href":"/api-reference/all-endpoints/analytics/resolve-a-plain-english-question-to-a-governed-widget"},{"title":"Mint a signed embeddable dashboard share link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/dashboards/share","href":"/api-reference/all-endpoints/analytics/mint-a-signed-embeddable-dashboard-share-link"},{"title":"List conversion goals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/goals","href":"/api-reference/all-endpoints/analytics/list-conversion-goals"},{"title":"Create a conversion goal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/goals","href":"/api-reference/all-endpoints/analytics/create-a-conversion-goal"},{"title":"Get one conversion goal","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/goals/{id}","href":"/api-reference/all-endpoints/analytics/get-one-conversion-goal"},{"title":"Delete a goal","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/analytics/goals/{id}","href":"/api-reference/all-endpoints/analytics/delete-a-goal"},{"title":"Update a goal","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/analytics/goals/{id}","href":"/api-reference/all-endpoints/analytics/update-a-goal"},{"title":"Record a conversion on a goal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/goals/{id}/record","href":"/api-reference/all-endpoints/analytics/record-a-conversion-on-a-goal"},{"title":"Create backfill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/goals/{id}/backfill","href":"/api-reference/all-endpoints/analytics/create-backfill"},{"title":"List a goal's conversions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/goals/{id}/conversions","href":"/api-reference/all-endpoints/analytics/list-a-goals-conversions"},{"title":"Aggregate conversion stats for one goal","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/goals/{id}/stats","href":"/api-reference/all-endpoints/analytics/aggregate-conversion-stats-for-one-goal"},{"title":"List satisfaction goals (CSAT / NPS / CES targets + progress)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/satisfaction-goals","href":"/api-reference/all-endpoints/analytics/list-satisfaction-goals-csat-nps-ces-targets-+-progress"},{"title":"Create a satisfaction goal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/satisfaction-goals","href":"/api-reference/all-endpoints/analytics/create-a-satisfaction-goal"},{"title":"Get one satisfaction goal with live progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/satisfaction-goals/{id}","href":"/api-reference/all-endpoints/analytics/get-one-satisfaction-goal-with-live-progress"},{"title":"Delete a satisfaction goal","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/analytics/satisfaction-goals/{id}","href":"/api-reference/all-endpoints/analytics/delete-a-satisfaction-goal"},{"title":"Update a satisfaction goal","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/analytics/satisfaction-goals/{id}","href":"/api-reference/all-endpoints/analytics/update-a-satisfaction-goal"},{"title":"List self-serve KPI alert rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/kpi-alert-rules","href":"/api-reference/all-endpoints/analytics/list-self-serve-kpi-alert-rules"},{"title":"Create a KPI alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/kpi-alert-rules","href":"/api-reference/all-endpoints/analytics/create-a-kpi-alert-rule"},{"title":"List fired KPI alert events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/analytics/kpi-alert-rules/events","href":"/api-reference/all-endpoints/analytics/list-fired-kpi-alert-events"},{"title":"Delete a KPI alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/analytics/kpi-alert-rules/{id}","href":"/api-reference/all-endpoints/analytics/delete-a-kpi-alert-rule"},{"title":"Update a KPI alert rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/analytics/kpi-alert-rules/{id}","href":"/api-reference/all-endpoints/analytics/update-a-kpi-alert-rule"},{"title":"Evaluate KPI alert rules on demand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/analytics/kpi-alert-rules/evaluate","href":"/api-reference/all-endpoints/analytics/evaluate-kpi-alert-rules-on-demand"}]},{"group":"Stats","pages":[{"title":"List carbon","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/carbon","href":"/api-reference/all-endpoints/stats/list-carbon"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/stats/analytics/carbon/export","href":"/api-reference/all-endpoints/stats/list-export"}]},{"group":"AI","pages":[{"title":"Analyze text (sentiment / intent / language / topics)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/analyze","href":"/api-reference/all-endpoints/ai/analyze-text-sentiment-intent-language-topics"},{"title":"Translate text to a target language","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/translate","href":"/api-reference/all-endpoints/ai/translate-text-to-a-target-language"},{"title":"Analyze a stored message by ID and persist the analysis","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/analyze-message/{id}","href":"/api-reference/all-endpoints/ai/analyze-a-stored-message-by-id-and-persist-the-analysis"},{"title":"Generate embedding vectors for one or more input strings","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/embeddings","href":"/api-reference/all-endpoints/ai/generate-embedding-vectors-for-one-or-more-input-strings"},{"title":"OpenAI-compatible chat completion (general inference)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/chat/completions","href":"/api-reference/all-endpoints/ai/openai-compatible-chat-completion-general-inference"},{"title":"Generate AI-suggested replies for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/suggest-reply","href":"/api-reference/all-endpoints/ai/generate-ai-suggested-replies-for-a-conversation"},{"title":"Summarize a conversation thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/summarize-conversation","href":"/api-reference/all-endpoints/ai/summarize-a-conversation-thread"},{"title":"Classify the customer's intent from a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/classify-intent","href":"/api-reference/all-endpoints/ai/classify-the-customers-intent-from-a-conversation"},{"title":"Generate channel-appropriate message content from a prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/generate-content","href":"/api-reference/all-endpoints/ai/generate-channel-appropriate-message-content-from-a-prompt"},{"title":"Improve, shorten, lengthen, or rephrase existing text","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/improve-text","href":"/api-reference/all-endpoints/ai/improve-shorten-lengthen-or-rephrase-existing-text"},{"title":"Generate AI-powered dashboard insights from stats","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/dashboard-insights","href":"/api-reference/all-endpoints/ai/generate-ai-powered-dashboard-insights-from-stats"},{"title":"Recommend the optimal channel + fallbacks for a recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/optimize-channel","href":"/api-reference/all-endpoints/ai/recommend-the-optimal-channel-+-fallbacks-for-a-recipient"},{"title":"Draft a full campaign blueprint from a plain-English goal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/compose-campaign","href":"/api-reference/all-endpoints/ai/draft-a-full-campaign-blueprint-from-a-plain-english-goal"},{"title":"List knowledge-base documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ai/kb/documents","href":"/api-reference/all-endpoints/ai/list-knowledge-base-documents"},{"title":"Add a knowledge-base document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/documents","href":"/api-reference/all-endpoints/ai/add-a-knowledge-base-document"},{"title":"Import a help center into the knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/import/help-center","href":"/api-reference/all-endpoints/ai/import-a-help-center-into-the-knowledge-base"},{"title":"Get a knowledge-base document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ai/kb/documents/{id}","href":"/api-reference/all-endpoints/ai/get-a-knowledge-base-document"},{"title":"Delete a knowledge-base document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/ai/kb/documents/{id}","href":"/api-reference/all-endpoints/ai/delete-a-knowledge-base-document"},{"title":"Reindex a knowledge-base document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/documents/{id}/reindex","href":"/api-reference/all-endpoints/ai/reindex-a-knowledge-base-document"},{"title":"Mark a knowledge-base document as verified","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/documents/{id}/verify","href":"/api-reference/all-endpoints/ai/mark-a-knowledge-base-document-as-verified"},{"title":"Scan the knowledge base for stale documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ai/kb/staleness","href":"/api-reference/all-endpoints/ai/scan-the-knowledge-base-for-stale-documents"},{"title":"List knowledge-source connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ai/kb/connectors","href":"/api-reference/all-endpoints/ai/list-knowledge-source-connectors"},{"title":"Get a knowledge-source connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ai/kb/connectors/{id}","href":"/api-reference/all-endpoints/ai/get-a-knowledge-source-connector"},{"title":"Search the knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/search","href":"/api-reference/all-endpoints/ai/search-the-knowledge-base"},{"title":"Answer a question from the knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ai/kb/answers","href":"/api-reference/all-endpoints/ai/answer-a-question-from-the-knowledge-base"}]},{"group":"Campaigns","pages":[{"title":"Get aggregate campaign stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/stats","href":"/api-reference/all-endpoints/campaigns/get-aggregate-campaign-stats"},{"title":"Run a campaign compliance preflight","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/preflight","href":"/api-reference/all-endpoints/campaigns/run-a-campaign-compliance-preflight"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns","href":"/api-reference/all-endpoints/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns","href":"/api-reference/all-endpoints/campaigns/create-a-campaign"},{"title":"Get the Outbound Studio hub summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/outbound-hub","href":"/api-reference/all-endpoints/campaigns/get-the-outbound-studio-hub-summary"},{"title":"List journey templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/templates","href":"/api-reference/all-endpoints/campaigns/list-journey-templates"},{"title":"Get a journey template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/templates/{templateId}","href":"/api-reference/all-endpoints/campaigns/get-a-journey-template"},{"title":"Instantiate a journey template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/templates/{templateId}/instantiate","href":"/api-reference/all-endpoints/campaigns/instantiate-a-journey-template"},{"title":"Generate a campaign draft from a brief","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/from-brief","href":"/api-reference/all-endpoints/campaigns/generate-a-campaign-draft-from-a-brief"},{"title":"Translate template copy into locales","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/templates/translate","href":"/api-reference/all-endpoints/campaigns/translate-template-copy-into-locales"},{"title":"Prefill an AI brief from a quick prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/ai-brief/prefill","href":"/api-reference/all-endpoints/campaigns/prefill-an-ai-brief-from-a-quick-prompt"},{"title":"Suggest campaign copy with AI","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/ai-brief/suggest","href":"/api-reference/all-endpoints/campaigns/suggest-campaign-copy-with-ai"},{"title":"Generate a journey draft from a prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/journey/from-prompt","href":"/api-reference/all-endpoints/campaigns/generate-a-journey-draft-from-a-prompt"},{"title":"Preview a native campaign audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/audience/preview","href":"/api-reference/all-endpoints/campaigns/preview-a-native-campaign-audience"},{"title":"Preview campaign cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/preview-cost","href":"/api-reference/all-endpoints/campaigns/preview-campaign-cost"},{"title":"Check schedule conflicts for an audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/check-schedule-conflicts","href":"/api-reference/all-endpoints/campaigns/check-schedule-conflicts-for-an-audience"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}","href":"/api-reference/all-endpoints/campaigns/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/campaigns/{id}","href":"/api-reference/all-endpoints/campaigns/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/campaigns/{id}","href":"/api-reference/all-endpoints/campaigns/delete-a-campaign"},{"title":"List a campaign's recipients","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/recipients","href":"/api-reference/all-endpoints/campaigns/list-a-campaigns-recipients"},{"title":"Launch a campaign to its audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/send","href":"/api-reference/all-endpoints/campaigns/launch-a-campaign-to-its-audience"},{"title":"Pause a running campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/pause","href":"/api-reference/all-endpoints/campaigns/pause-a-running-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/resume","href":"/api-reference/all-endpoints/campaigns/resume-a-paused-campaign"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/cancel","href":"/api-reference/all-endpoints/campaigns/create-cancel"},{"title":"Reopen a cancelled campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/reopen","href":"/api-reference/all-endpoints/campaigns/reopen-a-cancelled-campaign"},{"title":"Abort a running campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/abort","href":"/api-reference/all-endpoints/campaigns/abort-a-running-campaign"},{"title":"Create clone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/clone","href":"/api-reference/all-endpoints/campaigns/create-clone"},{"title":"Get campaign delivery stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/stats","href":"/api-reference/all-endpoints/campaigns/get-campaign-delivery-stats"},{"title":"Get voice cost rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/voice-cost-rollup","href":"/api-reference/all-endpoints/campaigns/get-voice-cost-rollup"},{"title":"List cost","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/cost","href":"/api-reference/all-endpoints/campaigns/list-cost"},{"title":"List export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/export","href":"/api-reference/all-endpoints/campaigns/list-export"},{"title":"List drip campaign steps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/steps","href":"/api-reference/all-endpoints/campaigns/list-drip-campaign-steps"},{"title":"Replace drip campaign steps","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/steps","href":"/api-reference/all-endpoints/campaigns/replace-drip-campaign-steps"},{"title":"List drip-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/drip-analytics","href":"/api-reference/all-endpoints/campaigns/list-drip-analytics"},{"title":"Get journey message delivery analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey-analytics","href":"/api-reference/all-endpoints/campaigns/get-journey-message-delivery-analytics"},{"title":"Get journey node funnel analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey/node-analytics","href":"/api-reference/all-endpoints/campaigns/get-journey-node-funnel-analytics"},{"title":"Get journey holdout lift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey/holdout-lift","href":"/api-reference/all-endpoints/campaigns/get-journey-holdout-lift"},{"title":"Get campaign holdout lift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/holdout-lift","href":"/api-reference/all-endpoints/campaigns/get-campaign-holdout-lift"},{"title":"Create execute-drip-step","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/execute-drip-step","href":"/api-reference/all-endpoints/campaigns/create-execute-drip-step"},{"title":"Optimize a campaign with AI suggestions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/optimize","href":"/api-reference/all-endpoints/campaigns/optimize-a-campaign-with-ai-suggestions"},{"title":"Re-queue a campaign's failed sends","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/resend-failed","href":"/api-reference/all-endpoints/campaigns/re-queue-a-campaigns-failed-sends"},{"title":"Resume a journey enrollment from a node","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/resume-journey","href":"/api-reference/all-endpoints/campaigns/resume-a-journey-enrollment-from-a-node"},{"title":"Create enroll-contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/enroll-contact","href":"/api-reference/all-endpoints/campaigns/create-enroll-contact"},{"title":"Create enroll-segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/enroll-segment","href":"/api-reference/all-endpoints/campaigns/create-enroll-segment"},{"title":"Enroll new segment members (internal)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/internal/segment-entry","href":"/api-reference/all-endpoints/campaigns/enroll-new-segment-members-internal"},{"title":"Unenroll departed segment members (internal)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/internal/segment-exit","href":"/api-reference/all-endpoints/campaigns/unenroll-departed-segment-members-internal"},{"title":"Preview smart-send per-contact schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/preview-smart-send","href":"/api-reference/all-endpoints/campaigns/preview-smart-send-per-contact-schedule"},{"title":"Plan a cross-campaign send schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/cross-schedule/preview","href":"/api-reference/all-endpoints/campaigns/plan-a-cross-campaign-send-schedule"},{"title":"Preview send-time experiment cohort plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/send-time-experiment/preview","href":"/api-reference/all-endpoints/campaigns/preview-send-time-experiment-cohort-plan"},{"title":"Get send-time experiment lift report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/send-time-experiment/results","href":"/api-reference/all-endpoints/campaigns/get-send-time-experiment-lift-report"},{"title":"Get smart-send holdout lift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/smart-send-holdout-lift","href":"/api-reference/all-endpoints/campaigns/get-smart-send-holdout-lift"},{"title":"Preview a campaign launch (dry run)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/dry-run","href":"/api-reference/all-endpoints/campaigns/preview-a-campaign-launch-dry-run"},{"title":"Simulate a journey graph","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/journeys/simulate","href":"/api-reference/all-endpoints/campaigns/simulate-a-journey-graph"},{"title":"Score draft campaign content for deliverability (pre-flight)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/deliverability-lab","href":"/api-reference/all-endpoints/campaigns/score-draft-campaign-content-for-deliverability-pre-flight"},{"title":"Get the deliverability seed-lab report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/deliverability-seed-lab","href":"/api-reference/all-endpoints/campaigns/get-the-deliverability-seed-lab-report"},{"title":"Register a seed-lab test recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/deliverability-seed-lab/recipients","href":"/api-reference/all-endpoints/campaigns/register-a-seed-lab-test-recipient"},{"title":"Remove a seed-lab test recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/campaigns/deliverability-seed-lab/recipients/{recipientId}","href":"/api-reference/all-endpoints/campaigns/remove-a-seed-lab-test-recipient"},{"title":"Set A/B variants and governance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/variants","href":"/api-reference/all-endpoints/campaigns/set-ab-variants-and-governance"},{"title":"Get A/B test results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/ab-results","href":"/api-reference/all-endpoints/campaigns/get-ab-test-results"},{"title":"Create generate-variants","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/generate-variants","href":"/api-reference/all-endpoints/campaigns/create-generate-variants"},{"title":"Select the A/B test winner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/ab-select-winner","href":"/api-reference/all-endpoints/campaigns/select-the-ab-test-winner"},{"title":"Record an in-journey A/B split conversion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/ab-split/{nodeId}/conversion","href":"/api-reference/all-endpoints/campaigns/record-an-in-journey-ab-split-conversion"},{"title":"Get in-journey A/B split results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/ab-split/{nodeId}/results","href":"/api-reference/all-endpoints/campaigns/get-in-journey-ab-split-results"},{"title":"Get a contact's A/B split assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/ab-split/{nodeId}/assignment","href":"/api-reference/all-endpoints/campaigns/get-a-contacts-ab-split-assignment"},{"title":"Get the journey conversion goal","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey/goal","href":"/api-reference/all-endpoints/campaigns/get-the-journey-conversion-goal"},{"title":"Set the journey conversion goal","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/campaigns/{id}/journey/goal","href":"/api-reference/all-endpoints/campaigns/set-the-journey-conversion-goal"},{"title":"Record a journey goal conversion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/journey/goal/conversion","href":"/api-reference/all-endpoints/campaigns/record-a-journey-goal-conversion"},{"title":"Get journey goal analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey/goal/analytics","href":"/api-reference/all-endpoints/campaigns/get-journey-goal-analytics"},{"title":"Get conversion channel pathing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/journey/pathing","href":"/api-reference/all-endpoints/campaigns/get-conversion-channel-pathing"},{"title":"Return on ad spend for one campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/roas","href":"/api-reference/all-endpoints/campaigns/return-on-ad-spend-for-one-campaign"},{"title":"ROAS broken down by template or message","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/roas/touchpoints","href":"/api-reference/all-endpoints/campaigns/roas-broken-down-by-template-or-message"},{"title":"List attribution-funnel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/attribution-funnel","href":"/api-reference/all-endpoints/campaigns/list-attribution-funnel"},{"title":"Get bulk campaign ROI summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/roi-summary","href":"/api-reference/all-endpoints/campaigns/get-bulk-campaign-roi-summary"},{"title":"ROI attribution per channel for one campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/roi-attribution","href":"/api-reference/all-endpoints/campaigns/roi-attribution-per-channel-for-one-campaign"},{"title":"List connected CRM audience providers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/audience-sources/providers","href":"/api-reference/all-endpoints/campaigns/list-connected-crm-audience-providers"},{"title":"List CRM audience containers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/audience-sources/{provider}/containers","href":"/api-reference/all-endpoints/campaigns/list-crm-audience-containers"},{"title":"Preview a CRM or CDP account audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/audience-sources/preview","href":"/api-reference/all-endpoints/campaigns/preview-a-crm-or-cdp-account-audience"},{"title":"List pending campaign approvals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/approvals/pending","href":"/api-reference/all-endpoints/campaigns/list-pending-campaign-approvals"},{"title":"Approve a pending campaign launch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/approve","href":"/api-reference/all-endpoints/campaigns/approve-a-pending-campaign-launch"},{"title":"Reject a campaign pending supervisor approval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/campaigns/{id}/reject","href":"/api-reference/all-endpoints/campaigns/reject-a-campaign-pending-supervisor-approval"},{"title":"Get campaign approval policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/approvals/settings","href":"/api-reference/all-endpoints/campaigns/get-campaign-approval-policy"},{"title":"Update campaign approval policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/campaigns/approvals/settings","href":"/api-reference/all-endpoints/campaigns/update-campaign-approval-policy"},{"title":"List template variables","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/template-variables","href":"/api-reference/all-endpoints/campaigns/list-template-variables"},{"title":"Get the campaign audience cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/audience-cap/settings","href":"/api-reference/all-endpoints/campaigns/get-the-campaign-audience-cap"},{"title":"Update the campaign audience cap","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/campaigns/audience-cap/settings","href":"/api-reference/all-endpoints/campaigns/update-the-campaign-audience-cap"},{"title":"Get the default quiet-hours window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/quiet-hours/settings","href":"/api-reference/all-endpoints/campaigns/get-the-default-quiet-hours-window"},{"title":"Update the default quiet-hours window","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/campaigns/quiet-hours/settings","href":"/api-reference/all-endpoints/campaigns/update-the-default-quiet-hours-window"},{"title":"List governance-summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/campaigns/{id}/governance-summary","href":"/api-reference/all-endpoints/campaigns/list-governance-summary"}]},{"group":"Knowledge Bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases","href":"/api-reference/all-endpoints/knowledge-bases/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases","href":"/api-reference/all-endpoints/knowledge-bases/create-a-knowledge-base"},{"title":"Get a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}","href":"/api-reference/all-endpoints/knowledge-bases/get-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/knowledge-bases/{id}","href":"/api-reference/all-endpoints/knowledge-bases/update-a-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/knowledge-bases/{id}","href":"/api-reference/all-endpoints/knowledge-bases/delete-a-knowledge-base"},{"title":"List documents in a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/documents","href":"/api-reference/all-endpoints/knowledge-bases/list-documents-in-a-knowledge-base"},{"title":"Retry document indexing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/documents/{docId}/retry","href":"/api-reference/all-endpoints/knowledge-bases/retry-document-indexing"},{"title":"List knowledge-base connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/connectors","href":"/api-reference/all-endpoints/knowledge-bases/list-knowledge-base-connectors"},{"title":"Add a connector to a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/connectors","href":"/api-reference/all-endpoints/knowledge-bases/add-a-connector-to-a-knowledge-base"},{"title":"Delete a knowledge-base connector","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/knowledge-bases/{id}/connectors/{connectorId}","href":"/api-reference/all-endpoints/knowledge-bases/delete-a-knowledge-base-connector"},{"title":"Update a knowledge-base connector","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/knowledge-bases/{id}/connectors/{connectorId}","href":"/api-reference/all-endpoints/knowledge-bases/update-a-knowledge-base-connector"},{"title":"Sync a connector immediately","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/connectors/{connectorId}/sync","href":"/api-reference/all-endpoints/knowledge-bases/sync-a-connector-immediately"},{"title":"Get knowledge-base connector drift report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/connector-drift-report","href":"/api-reference/all-endpoints/knowledge-bases/get-knowledge-base-connector-drift-report"},{"title":"Get knowledge-base search config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/search-config","href":"/api-reference/all-endpoints/knowledge-bases/get-knowledge-base-search-config"},{"title":"Update knowledge-base search config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/knowledge-bases/{id}/search-config","href":"/api-reference/all-endpoints/knowledge-bases/update-knowledge-base-search-config"}]},{"group":"KnowledgeBases","pages":[{"title":"Upload a document to a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/documents","href":"/api-reference/all-endpoints/knowledgebases/upload-a-document-to-a-knowledge-base"},{"title":"Get knowledge-base staleness report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/staleness","href":"/api-reference/all-endpoints/knowledgebases/get-knowledge-base-staleness-report"},{"title":"Delete a knowledge-base document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/knowledge-bases/{id}/documents/{docId}","href":"/api-reference/all-endpoints/knowledgebases/delete-a-knowledge-base-document"},{"title":"List document versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/documents/{docId}/versions","href":"/api-reference/all-endpoints/knowledgebases/list-document-versions"},{"title":"Diff two document versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/knowledge-bases/{id}/documents/{docId}/versions/diff","href":"/api-reference/all-endpoints/knowledgebases/diff-two-document-versions"},{"title":"Roll back a document to a prior version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/documents/{docId}/rollback","href":"/api-reference/all-endpoints/knowledgebases/roll-back-a-document-to-a-prior-version"},{"title":"Approve a document for retrieval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/documents/{docId}/approve","href":"/api-reference/all-endpoints/knowledgebases/approve-a-document-for-retrieval"},{"title":"Reject a document from retrieval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/documents/{docId}/reject","href":"/api-reference/all-endpoints/knowledgebases/reject-a-document-from-retrieval"},{"title":"Trigger an immediate knowledge-base refresh","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/refresh","href":"/api-reference/all-endpoints/knowledgebases/trigger-an-immediate-knowledge-base-refresh"},{"title":"Update document help-center publication","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/knowledge-bases/{id}/documents/{docId}/publication","href":"/api-reference/all-endpoints/knowledgebases/update-document-help-center-publication"},{"title":"Search a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/knowledge-bases/{id}/search","href":"/api-reference/all-endpoints/knowledgebases/search-a-knowledge-base"}]},{"group":"Organization","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization","href":"/api-reference/all-endpoints/organization/get-the-current-organization"},{"title":"Update the current organization","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization","href":"/api-reference/all-endpoints/organization/update-the-current-organization"},{"title":"Submit KYC verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/kyc/submit","href":"/api-reference/all-endpoints/organization/submit-kyc-verification"},{"title":"Get KYC verification status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/kyc/status","href":"/api-reference/all-endpoints/organization/get-kyc-verification-status"},{"title":"Get KYC verification status (legacy alias)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/kyc","href":"/api-reference/all-endpoints/organization/get-kyc-verification-status-legacy-alias"},{"title":"Start an eKYC identity-verification session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/kyc/idv/session","href":"/api-reference/all-endpoints/organization/start-an-ekyc-identity-verification-session"},{"title":"Get eKYC identity-verification status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/kyc/idv/status","href":"/api-reference/all-endpoints/organization/get-ekyc-identity-verification-status"},{"title":"Get KYB business-screening status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/kyb/status","href":"/api-reference/all-endpoints/organization/get-kyb-business-screening-status"},{"title":"Get account-trust status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/account-status","href":"/api-reference/all-endpoints/organization/get-account-trust-status"},{"title":"Get reseller mode slice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/reseller","href":"/api-reference/all-endpoints/organization/get-reseller-mode-slice"},{"title":"Update reseller mode flag","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/organization/reseller/mode","href":"/api-reference/all-endpoints/organization/update-reseller-mode-flag"},{"title":"Resolve reseller provider","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/reseller/resolve/{providerType}","href":"/api-reference/all-endpoints/organization/resolve-reseller-provider"},{"title":"Connect a reseller BYO provider","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization/reseller/providers/{providerType}","href":"/api-reference/all-endpoints/organization/connect-a-reseller-byo-provider"},{"title":"Disconnect a reseller BYO provider","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organization/reseller/providers/{providerType}","href":"/api-reference/all-endpoints/organization/disconnect-a-reseller-byo-provider"},{"title":"Get curated LLM provider slice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/llm-provider","href":"/api-reference/all-endpoints/organization/get-curated-llm-provider-slice"},{"title":"Record the org's curated LLM provider selection","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization/llm-provider","href":"/api-reference/all-endpoints/organization/record-the-orgs-curated-llm-provider-selection"},{"title":"Resolve the org's curated LLM provider","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/llm-provider/resolve","href":"/api-reference/all-endpoints/organization/resolve-the-orgs-curated-llm-provider"},{"title":"Get default business hours","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/business-hours","href":"/api-reference/all-endpoints/organization/get-default-business-hours"},{"title":"Update default business hours","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization/business-hours","href":"/api-reference/all-endpoints/organization/update-default-business-hours"},{"title":"Get organization branding","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/branding","href":"/api-reference/all-endpoints/organization/get-organization-branding"},{"title":"Update organization branding","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization/branding","href":"/api-reference/all-endpoints/organization/update-organization-branding"},{"title":"Reset organization branding","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/branding/reset","href":"/api-reference/all-endpoints/organization/reset-organization-branding"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/domains","href":"/api-reference/all-endpoints/organization/list-custom-domains"},{"title":"Add a custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/domains","href":"/api-reference/all-endpoints/organization/add-a-custom-domain"},{"title":"Remove a custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organization/domains/{domainId}","href":"/api-reference/all-endpoints/organization/remove-a-custom-domain"},{"title":"Verify a custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/domains/{domainId}/verify","href":"/api-reference/all-endpoints/organization/verify-a-custom-domain"},{"title":"List organization members (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/members","href":"/api-reference/all-endpoints/organization/list-organization-members-sdk-alias"},{"title":"Update a member's role (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/organization/members/{id}","href":"/api-reference/all-endpoints/organization/update-a-members-role-sdk-alias"},{"title":"Remove a member (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organization/members/{id}","href":"/api-reference/all-endpoints/organization/remove-a-member-sdk-alias"},{"title":"List pending organization invites (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/invites","href":"/api-reference/all-endpoints/organization/list-pending-organization-invites-sdk-alias"},{"title":"Invite a member (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/invites","href":"/api-reference/all-endpoints/organization/invite-a-member-sdk-alias"},{"title":"Resend a pending invite (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/invites/{id}/resend","href":"/api-reference/all-endpoints/organization/resend-a-pending-invite-sdk-alias"},{"title":"Revoke a pending invite (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organization/invites/{id}","href":"/api-reference/all-endpoints/organization/revoke-a-pending-invite-sdk-alias"},{"title":"List organization API keys (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organization/api-keys","href":"/api-reference/all-endpoints/organization/list-organization-api-keys-sdk-alias"},{"title":"Create an API key (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/api-keys","href":"/api-reference/all-endpoints/organization/create-an-api-key-sdk-alias"},{"title":"Rotate an API key (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organization/api-keys/{id}/rotate","href":"/api-reference/all-endpoints/organization/rotate-an-api-key-sdk-alias"},{"title":"Revoke an API key (SDK alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organization/api-keys/{id}","href":"/api-reference/all-endpoints/organization/revoke-an-api-key-sdk-alias"},{"title":"Resolve a custom domain to its organization","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/resolve-domain","href":"/api-reference/all-endpoints/organization/resolve-a-custom-domain-to-its-organization"},{"title":"Resolve an organization to its branded domain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/resolve-org-domain","href":"/api-reference/all-endpoints/organization/resolve-an-organization-to-its-branded-domain"},{"title":"Resolve a custom domain's presentational branding","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/branding","href":"/api-reference/all-endpoints/organization/resolve-a-custom-domains-presentational-branding"},{"title":"List presence","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/users/presence","href":"/api-reference/all-endpoints/organization/list-presence"},{"title":"List schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/users/me/presence/schedule","href":"/api-reference/all-endpoints/organization/list-schedule"},{"title":"List federation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/users/me/presence/federation","href":"/api-reference/all-endpoints/organization/list-federation"},{"title":"Update federation","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/users/me/presence/federation/{provider}","href":"/api-reference/all-endpoints/organization/update-federation"},{"title":"Delete federation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/users/me/presence/federation/{provider}","href":"/api-reference/all-endpoints/organization/delete-federation"}]},{"group":"Organizations","pages":[{"title":"List sla-report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organizations/sla-report","href":"/api-reference/all-endpoints/organizations/list-sla-report"},{"title":"List credit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/organizations/sla-report/credit","href":"/api-reference/all-endpoints/organizations/list-credit"},{"title":"Mint a workspace-deletion re-auth challenge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/organizations/{id}/reauth-challenge","href":"/api-reference/all-endpoints/organizations/mint-a-workspace-deletion-re-auth-challenge"},{"title":"Delete the caller's workspace","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/organizations/{id}","href":"/api-reference/all-endpoints/organizations/delete-the-callers-workspace"}]},{"group":"Marketplace","pages":[{"title":"List marketplace listings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/marketplace","href":"/api-reference/all-endpoints/marketplace/list-marketplace-listings"},{"title":"Create a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/marketplace","href":"/api-reference/all-endpoints/marketplace/create-a-marketplace-listing"},{"title":"Get a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/marketplace/{id}","href":"/api-reference/all-endpoints/marketplace/get-a-marketplace-listing"},{"title":"Update a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/marketplace/{id}","href":"/api-reference/all-endpoints/marketplace/update-a-marketplace-listing"},{"title":"Delete a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/marketplace/{id}","href":"/api-reference/all-endpoints/marketplace/delete-a-marketplace-listing"},{"title":"List your own marketplace listings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/marketplace/mine","href":"/api-reference/all-endpoints/marketplace/list-your-own-marketplace-listings"},{"title":"Install a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/marketplace/{id}/install","href":"/api-reference/all-endpoints/marketplace/install-a-marketplace-listing"}]},{"group":"Events","pages":[{"title":"List event history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events","href":"/api-reference/all-endpoints/events/list-event-history"},{"title":"Get event details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events/{id}","href":"/api-reference/all-endpoints/events/get-event-details"},{"title":"Subscribe to the real-time platform event stream (SSE)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events/stream","href":"/api-reference/all-endpoints/events/subscribe-to-the-real-time-platform-event-stream-sse"},{"title":"Consume events for a consumer group","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events/consume","href":"/api-reference/all-endpoints/events/consume-events-for-a-consumer-group"},{"title":"Commit a consumer-group offset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/events/consume/commit","href":"/api-reference/all-endpoints/events/commit-a-consumer-group-offset"},{"title":"Seek a consumer group (replay / backfill)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/events/consume/seek","href":"/api-reference/all-endpoints/events/seek-a-consumer-group-replay-backfill"},{"title":"List consumer groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events/consumer-groups","href":"/api-reference/all-endpoints/events/list-consumer-groups"},{"title":"Get the versioned event schema registry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/events/schema-registry","href":"/api-reference/all-endpoints/events/get-the-versioned-event-schema-registry"},{"title":"Track a product event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/events/track","href":"/api-reference/all-endpoints/events/track-a-product-event"}]},{"group":"Reports","pages":[{"title":"Generate an on-demand report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/reports/generate","href":"/api-reference/all-endpoints/reports/generate-an-on-demand-report"},{"title":"Escalations grouped by reason code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/reports/escalation-by-reason","href":"/api-reference/all-endpoints/reports/escalations-grouped-by-reason-code"},{"title":"List active escalation reason codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/reports/escalation-reason-codes","href":"/api-reference/all-endpoints/reports/list-active-escalation-reason-codes"},{"title":"Get the monthly SLA attestation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/reports/sla-attestation","href":"/api-reference/all-endpoints/reports/get-the-monthly-sla-attestation"},{"title":"List queue-sla","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/reports/queue-sla","href":"/api-reference/all-endpoints/reports/list-queue-sla"}]},{"group":"Feedback","pages":[{"title":"Submit product feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/feedback","href":"/api-reference/all-endpoints/feedback/submit-product-feedback"}]},{"group":"Pricing","pages":[{"title":"Get messaging rates for a country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/messaging","href":"/api-reference/all-endpoints/pricing/get-messaging-rates-for-a-country"},{"title":"Get voice rates for a country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/voice","href":"/api-reference/all-endpoints/pricing/get-voice-rates-for-a-country"},{"title":"Get phone-number rental prices for a country","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/phone-numbers","href":"/api-reference/all-endpoints/pricing/get-phone-number-rental-prices-for-a-country"},{"title":"List all pricing rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/rates","href":"/api-reference/all-endpoints/pricing/list-all-pricing-rates"},{"title":"List organizations for the rate-card picker","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/organizations","href":"/api-reference/all-endpoints/pricing/list-organizations-for-the-rate-card-picker"},{"title":"Estimate the cost of a message","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/estimate","href":"/api-reference/all-endpoints/pricing/estimate-the-cost-of-a-message"},{"title":"Get the RTC-PaaS rate card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/rtc-rate-card","href":"/api-reference/all-endpoints/pricing/get-the-rtc-paas-rate-card"},{"title":"Simulate RTC-PaaS cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/pricing/rtc-simulate","href":"/api-reference/all-endpoints/pricing/simulate-rtc-paas-cost"},{"title":"Simulate what-if repricing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/pricing/whatif-simulate","href":"/api-reference/all-endpoints/pricing/simulate-what-if-repricing"},{"title":"List operator-level SMS rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/mccmnc-rates","href":"/api-reference/all-endpoints/pricing/list-operator-level-sms-rates"},{"title":"List per-org pricing overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/overrides","href":"/api-reference/all-endpoints/pricing/list-per-org-pricing-overrides"},{"title":"List pricing change history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/changelog","href":"/api-reference/all-endpoints/pricing/list-pricing-change-history"},{"title":"Get your effective rate sheet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/pricing/effective-rates","href":"/api-reference/all-endpoints/pricing/get-your-effective-rate-sheet"},{"title":"Get the published platform price list","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/pricing","href":"/api-reference/all-endpoints/pricing/get-the-published-platform-price-list"}]},{"group":"Email","pages":[{"title":"One-click email unsubscribe","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/unsubscribe/{token}","href":"/api-reference/all-endpoints/email/one-click-email-unsubscribe"},{"title":"One-click email unsubscribe","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/unsubscribe/{token}","href":"/api-reference/all-endpoints/email/one-click-email-unsubscribe-1"},{"title":"List inbound email routes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/inbound-routes","href":"/api-reference/all-endpoints/email/list-inbound-email-routes"},{"title":"Register an inbound email route","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/inbound-routes","href":"/api-reference/all-endpoints/email/register-an-inbound-email-route"},{"title":"Delete an inbound email route","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/email/inbound-routes/{routeId}","href":"/api-reference/all-endpoints/email/delete-an-inbound-email-route"},{"title":"List sending domains","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains","href":"/api-reference/all-endpoints/email/list-sending-domains"},{"title":"Read one email sending domain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains/{domainId}","href":"/api-reference/all-endpoints/email/read-one-email-sending-domain"},{"title":"Analyze DMARC aggregate reports","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/dmarc/reports/analyze","href":"/api-reference/all-endpoints/email/analyze-dmarc-aggregate-reports"},{"title":"Analyze TLS-RPT aggregate reports","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/tls-rpt/reports/analyze","href":"/api-reference/all-endpoints/email/analyze-tls-rpt-aggregate-reports"},{"title":"Analyze Google Postmaster Tools + feedback-loop reputation data","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/postmaster/reputation/analyze","href":"/api-reference/all-endpoints/email/analyze-google-postmaster-tools-+-feedback-loop-reputation-data"},{"title":"Check domain DNS records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains/{domainId}/dns-status","href":"/api-reference/all-endpoints/email/check-domain-dns-records"},{"title":"Kick provider domain re-verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/domains/{domainId}/provider-verify","href":"/api-reference/all-endpoints/email/kick-provider-domain-re-verification"},{"title":"Get domain DNS verification history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains/{domainId}/dns-history","href":"/api-reference/all-endpoints/email/get-domain-dns-verification-history"},{"title":"Get domain inbox placement rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains/{domainId}/inbox-placement","href":"/api-reference/all-endpoints/email/get-domain-inbox-placement-rate"},{"title":"Initiate a test email send","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/domains/{domainId}/test-send","href":"/api-reference/all-endpoints/email/initiate-a-test-email-send"},{"title":"Get test email send result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/domains/{domainId}/test-send/{testId}/result","href":"/api-reference/all-endpoints/email/get-test-email-send-result"},{"title":"Validate a recipient email address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/validate","href":"/api-reference/all-endpoints/email/validate-a-recipient-email-address"},{"title":"Configure BIMI brand logo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/domains/{domainId}/bimi","href":"/api-reference/all-endpoints/email/configure-bimi-brand-logo"},{"title":"Run the MTA-STS + TLS-RPT setup wizard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/domains/{domainId}/mta-sts","href":"/api-reference/all-endpoints/email/run-the-mta-sts-+-tls-rpt-setup-wizard"},{"title":"Auto-configure cloudflare","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/domains/{domainId}/cloudflare/auto-configure","href":"/api-reference/all-endpoints/email/auto-configure-cloudflare"},{"title":"Get IP warmup ramp plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/warmup-plan","href":"/api-reference/all-endpoints/email/get-ip-warmup-ramp-plan"},{"title":"Get live IP warmup status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/warmup-status","href":"/api-reference/all-endpoints/email/get-live-ip-warmup-status"},{"title":"Check batch send against warmup headroom","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/warmup-enforcement","href":"/api-reference/all-endpoints/email/check-batch-send-against-warmup-headroom"},{"title":"Check dedicated IP eligibility","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/dedicated-sending/eligibility","href":"/api-reference/all-endpoints/email/check-dedicated-ip-eligibility"},{"title":"Get dedicated sending status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/dedicated-sending","href":"/api-reference/all-endpoints/email/get-dedicated-sending-status"},{"title":"Request a dedicated sending IP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/dedicated-sending/request","href":"/api-reference/all-endpoints/email/request-a-dedicated-sending-ip"},{"title":"Bulk-validate recipient email addresses","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/validate/bulk","href":"/api-reference/all-endpoints/email/bulk-validate-recipient-email-addresses"},{"title":"List email senders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/senders","href":"/api-reference/all-endpoints/email/list-email-senders"},{"title":"Create an email sender","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/senders","href":"/api-reference/all-endpoints/email/create-an-email-sender"},{"title":"Get one email sender","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/senders/{senderId}","href":"/api-reference/all-endpoints/email/get-one-email-sender"},{"title":"Update an email sender","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/email/senders/{senderId}","href":"/api-reference/all-endpoints/email/update-an-email-sender"},{"title":"Delete an email sender","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/email/senders/{senderId}","href":"/api-reference/all-endpoints/email/delete-an-email-sender"},{"title":"Promote a sender to the org default","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/senders/{senderId}/set-default","href":"/api-reference/all-endpoints/email/promote-a-sender-to-the-org-default"},{"title":"List email sending streams","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/streams","href":"/api-reference/all-endpoints/email/list-email-sending-streams"},{"title":"Create an email sending stream","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/streams","href":"/api-reference/all-endpoints/email/create-an-email-sending-stream"},{"title":"Update an email sending stream","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/email/streams/{streamId}","href":"/api-reference/all-endpoints/email/update-an-email-sending-stream"},{"title":"Delete an email sending stream","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/email/streams/{streamId}","href":"/api-reference/all-endpoints/email/delete-an-email-sending-stream"},{"title":"Promote a stream to the org default","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/streams/{streamId}/set-default","href":"/api-reference/all-endpoints/email/promote-a-stream-to-the-org-default"},{"title":"List suppressed email addresses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/suppressions","href":"/api-reference/all-endpoints/email/list-suppressed-email-addresses"},{"title":"Add an email suppression","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/suppressions","href":"/api-reference/all-endpoints/email/add-an-email-suppression"},{"title":"Export suppression list as CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/suppressions/export","href":"/api-reference/all-endpoints/email/export-suppression-list-as-csv"},{"title":"Get sender-reputation summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/email/suppressions/reputation","href":"/api-reference/all-endpoints/email/get-sender-reputation-summary"},{"title":"Bulk-import email suppressions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/email/suppressions/bulk-import","href":"/api-reference/all-endpoints/email/bulk-import-email-suppressions"},{"title":"Remove an email suppression","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/email/suppressions/{id}","href":"/api-reference/all-endpoints/email/remove-an-email-suppression"}]},{"group":"Fax","pages":[{"title":"List fax message history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/fax","href":"/api-reference/all-endpoints/fax/list-fax-message-history"},{"title":"Get fax message details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/fax/{id}","href":"/api-reference/all-endpoints/fax/get-fax-message-details"},{"title":"Get fax delivery status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/fax/{id}/status","href":"/api-reference/all-endpoints/fax/get-fax-delivery-status"}]},{"group":"WhatsApp","pages":[{"title":"List webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/webhook","href":"/api-reference/all-endpoints/whatsapp/list-webhook"},{"title":"Webhook whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/webhook","href":"/api-reference/all-endpoints/whatsapp/webhook-whatsapp"},{"title":"Connect whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/connect","href":"/api-reference/all-endpoints/whatsapp/connect-whatsapp"},{"title":"List status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/status","href":"/api-reference/all-endpoints/whatsapp/list-status"},{"title":"List health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/health","href":"/api-reference/all-endpoints/whatsapp/list-health"},{"title":"List connections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/connections","href":"/api-reference/all-endpoints/whatsapp/list-connections"},{"title":"List exists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/connections/exists","href":"/api-reference/all-endpoints/whatsapp/list-exists"},{"title":"Update default","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/whatsapp/connections/{phoneNumberId}/default","href":"/api-reference/all-endpoints/whatsapp/update-default"},{"title":"Delete connections","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/connections/{phoneNumberId}","href":"/api-reference/all-endpoints/whatsapp/delete-connections"},{"title":"Patch connections","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/whatsapp/connections/{phoneNumberId}","href":"/api-reference/all-endpoints/whatsapp/patch-connections"},{"title":"Delete disconnect","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/disconnect","href":"/api-reference/all-endpoints/whatsapp/delete-disconnect"},{"title":"Create pre_accept","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/{callId}/pre_accept","href":"/api-reference/all-endpoints/whatsapp/create-pre_accept"},{"title":"Create accept","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/{callId}/accept","href":"/api-reference/all-endpoints/whatsapp/create-accept"},{"title":"Create reject","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/{callId}/reject","href":"/api-reference/all-endpoints/whatsapp/create-reject"},{"title":"Create terminate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/{callId}/terminate","href":"/api-reference/all-endpoints/whatsapp/create-terminate"},{"title":"Permission calls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/permission","href":"/api-reference/all-endpoints/whatsapp/permission-calls"},{"title":"Initiate calls","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calls/initiate","href":"/api-reference/all-endpoints/whatsapp/initiate-calls"},{"title":"List calling","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/connections/{phoneNumberId}/calling","href":"/api-reference/all-endpoints/whatsapp/list-calling"},{"title":"Enable calling","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/connections/{phoneNumberId}/calling/enable","href":"/api-reference/all-endpoints/whatsapp/enable-calling"},{"title":"Disable calling","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/connections/{phoneNumberId}/calling/disable","href":"/api-reference/all-endpoints/whatsapp/disable-calling"},{"title":"List permissions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/calling/permissions","href":"/api-reference/all-endpoints/whatsapp/list-permissions"},{"title":"Register-webhook calling","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/connections/{phoneNumberId}/calling/register-webhook","href":"/api-reference/all-endpoints/whatsapp/register-webhook-calling"},{"title":"Create accept","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calling/calls/{metaCallId}/accept","href":"/api-reference/all-endpoints/whatsapp/create-accept-1"},{"title":"Create decline","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calling/calls/{metaCallId}/decline","href":"/api-reference/all-endpoints/whatsapp/create-decline"},{"title":"List block-users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/block-users","href":"/api-reference/all-endpoints/whatsapp/list-block-users"},{"title":"Block-users whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/block-users","href":"/api-reference/all-endpoints/whatsapp/block-users-whatsapp"},{"title":"Unblock-users whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/unblock-users","href":"/api-reference/all-endpoints/whatsapp/unblock-users-whatsapp"},{"title":"List business-profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/business-profile","href":"/api-reference/all-endpoints/whatsapp/list-business-profile"},{"title":"Update business-profile","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/whatsapp/business-profile","href":"/api-reference/all-endpoints/whatsapp/update-business-profile"},{"title":"Picture business-profile","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/business-profile/picture","href":"/api-reference/all-endpoints/whatsapp/picture-business-profile"},{"title":"List conversational-automation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/conversational-automation","href":"/api-reference/all-endpoints/whatsapp/list-conversational-automation"},{"title":"Update conversational-automation","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/whatsapp/conversational-automation","href":"/api-reference/all-endpoints/whatsapp/update-conversational-automation"},{"title":"List catalogs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/businesses/{businessId}/catalogs","href":"/api-reference/all-endpoints/whatsapp/list-catalogs"},{"title":"List catalogs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/catalogs","href":"/api-reference/all-endpoints/whatsapp/list-catalogs-1"},{"title":"Catalogs whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/catalogs","href":"/api-reference/all-endpoints/whatsapp/catalogs-whatsapp"},{"title":"Delete catalogs","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/catalogs/{catalogId}","href":"/api-reference/all-endpoints/whatsapp/delete-catalogs"},{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/catalogs/{catalogId}/products","href":"/api-reference/all-endpoints/whatsapp/list-products"},{"title":"Create products","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/catalogs/{catalogId}/products","href":"/api-reference/all-endpoints/whatsapp/create-products"},{"title":"Update products","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/whatsapp/products/{productId}","href":"/api-reference/all-endpoints/whatsapp/update-products"},{"title":"Delete products","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/products/{productId}","href":"/api-reference/all-endpoints/whatsapp/delete-products"},{"title":"Send-flow messages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/messages/send-flow","href":"/api-reference/all-endpoints/whatsapp/send-flow-messages"},{"title":"Send WhatsApp interactive message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/messages/send-interactive","href":"/api-reference/all-endpoints/whatsapp/send-whatsapp-interactive-message"},{"title":"Send WhatsApp location-request message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/messages/send-location-request","href":"/api-reference/all-endpoints/whatsapp/send-whatsapp-location-request-message"},{"title":"Send WhatsApp address-request message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/messages/send-address-request","href":"/api-reference/all-endpoints/whatsapp/send-whatsapp-address-request-message"},{"title":"List pricing-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/pricing-analytics","href":"/api-reference/all-endpoints/whatsapp/list-pricing-analytics"},{"title":"Create edit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/templates/{externalId}/edit","href":"/api-reference/all-endpoints/whatsapp/create-edit"},{"title":"Delete templates","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/templates/{name}","href":"/api-reference/all-endpoints/whatsapp/delete-templates"},{"title":"Request-code phone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/phone/request-code","href":"/api-reference/all-endpoints/whatsapp/request-code-phone"},{"title":"Verify-code phone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/phone/verify-code","href":"/api-reference/all-endpoints/whatsapp/verify-code-phone"},{"title":"Sync templates","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/templates/sync","href":"/api-reference/all-endpoints/whatsapp/sync-templates"},{"title":"List library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/templates/library","href":"/api-reference/all-endpoints/whatsapp/list-library"},{"title":"Library templates","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/templates/library","href":"/api-reference/all-endpoints/whatsapp/library-templates"},{"title":"List quality","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/quality","href":"/api-reference/all-endpoints/whatsapp/list-quality"},{"title":"List phone-numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/phone-numbers","href":"/api-reference/all-endpoints/whatsapp/list-phone-numbers"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/templates","href":"/api-reference/all-endpoints/whatsapp/list-templates"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/flows","href":"/api-reference/all-endpoints/whatsapp/list-flows"},{"title":"Flows whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/flows","href":"/api-reference/all-endpoints/whatsapp/flows-whatsapp"},{"title":"Get flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/flows/{flowId}","href":"/api-reference/all-endpoints/whatsapp/get-flows"},{"title":"Delete flows","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/whatsapp/flows/{flowId}","href":"/api-reference/all-endpoints/whatsapp/delete-flows"},{"title":"List json","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/flows/{flowId}/json","href":"/api-reference/all-endpoints/whatsapp/list-json"},{"title":"Create assets","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/flows/{flowId}/assets","href":"/api-reference/all-endpoints/whatsapp/create-assets"},{"title":"Create publish","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/flows/{flowId}/publish","href":"/api-reference/all-endpoints/whatsapp/create-publish"},{"title":"List funnel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/flows/{flowId}/funnel","href":"/api-reference/all-endpoints/whatsapp/list-funnel"},{"title":"List submissions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/flows/{flowId}/submissions","href":"/api-reference/all-endpoints/whatsapp/list-submissions"},{"title":"Generate flows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/flows/generate","href":"/api-reference/all-endpoints/whatsapp/generate-flows"},{"title":"Create send","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/catalogs/{catalogId}/send","href":"/api-reference/all-endpoints/whatsapp/create-send"},{"title":"List catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/catalog","href":"/api-reference/all-endpoints/whatsapp/list-catalog"},{"title":"Send catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/catalog/send","href":"/api-reference/all-endpoints/whatsapp/send-catalog"},{"title":"Send-list catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/catalog/send-list","href":"/api-reference/all-endpoints/whatsapp/send-list-catalog"},{"title":"Get media","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/media/{mediaId}","href":"/api-reference/all-endpoints/whatsapp/get-media"},{"title":"List download","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/media/{mediaId}/download","href":"/api-reference/all-endpoints/whatsapp/list-download"},{"title":"Generate templates","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/templates/generate","href":"/api-reference/all-endpoints/whatsapp/generate-templates"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/analytics/templates","href":"/api-reference/all-endpoints/whatsapp/list-templates-1"},{"title":"List costs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/analytics/costs","href":"/api-reference/all-endpoints/whatsapp/list-costs"},{"title":"Plan WhatsApp campaign cost optimization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/cost-optimizer/plan","href":"/api-reference/all-endpoints/whatsapp/plan-whatsapp-campaign-cost-optimization"},{"title":"Estimate WhatsApp marketing campaign cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/cost-optimizer/estimate","href":"/api-reference/all-endpoints/whatsapp/estimate-whatsapp-marketing-campaign-cost"},{"title":"Send WhatsApp marketing message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/marketing-messages/send","href":"/api-reference/all-endpoints/whatsapp/send-whatsapp-marketing-message"},{"title":"Create read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/messages/{messageId}/read","href":"/api-reference/all-endpoints/whatsapp/create-read"},{"title":"Create read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/conversations/{conversationId}/read","href":"/api-reference/all-endpoints/whatsapp/create-read-1"},{"title":"Create archive","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/conversations/{conversationId}/archive","href":"/api-reference/all-endpoints/whatsapp/create-archive"},{"title":"List search","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/conversations/search","href":"/api-reference/all-endpoints/whatsapp/list-search"},{"title":"Create resolve-bsuid","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/conversations/{conversationId}/resolve-bsuid","href":"/api-reference/all-endpoints/whatsapp/create-resolve-bsuid"},{"title":"List status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/test-account/status","href":"/api-reference/all-endpoints/whatsapp/list-status-1"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/test-account/analytics","href":"/api-reference/all-endpoints/whatsapp/list-analytics"},{"title":"Send-otp test-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/test-account/send-otp","href":"/api-reference/all-endpoints/whatsapp/send-otp-test-account"},{"title":"Verify-otp test-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/test-account/verify-otp","href":"/api-reference/all-endpoints/whatsapp/verify-otp-test-account"},{"title":"List kb-config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/kb-config","href":"/api-reference/all-endpoints/whatsapp/list-kb-config"},{"title":"Kb-config whatsapp","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/kb-config","href":"/api-reference/all-endpoints/whatsapp/kb-config-whatsapp"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/test-account/flows","href":"/api-reference/all-endpoints/whatsapp/list-flows-1"},{"title":"List catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/test-account/catalog","href":"/api-reference/all-endpoints/whatsapp/list-catalog-1"},{"title":"List calling-availability","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/test-account/calling-availability","href":"/api-reference/all-endpoints/whatsapp/list-calling-availability"},{"title":"Change-number test-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/test-account/change-number","href":"/api-reference/all-endpoints/whatsapp/change-number-test-account"},{"title":"Clear-verification test-account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/test-account/clear-verification","href":"/api-reference/all-endpoints/whatsapp/clear-verification-test-account"}]},{"group":"WhatsApp Calling","pages":[{"title":"List WhatsApp Business Call logs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/calling/calls","href":"/api-reference/all-endpoints/whatsapp-calling/list-whatsapp-business-call-logs"},{"title":"Initiate an outbound WhatsApp Business Call (Phase 5)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/whatsapp/calling/calls","href":"/api-reference/all-endpoints/whatsapp-calling/initiate-an-outbound-whatsapp-business-call-phase-5"},{"title":"WhatsApp Business Calling KPIs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/whatsapp/calling/analytics","href":"/api-reference/all-endpoints/whatsapp-calling/whatsapp-business-calling-kpis"}]},{"group":"RCS","pages":[{"title":"Combined first RCS setup (brand + first bot)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/setup","href":"/api-reference/all-endpoints/rcs/combined-first-rcs-setup-brand-+-first-bot"},{"title":"List RCS brands","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/brands","href":"/api-reference/all-endpoints/rcs/list-rcs-brands"},{"title":"Create RCS brand","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/brands","href":"/api-reference/all-endpoints/rcs/create-rcs-brand"},{"title":"Get RCS brand summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/brands/summary","href":"/api-reference/all-endpoints/rcs/get-rcs-brand-summary"},{"title":"Get RCS brand","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/brands/{id}","href":"/api-reference/all-endpoints/rcs/get-rcs-brand"},{"title":"Delete RCS brand","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/rcs/brands/{id}","href":"/api-reference/all-endpoints/rcs/delete-rcs-brand"},{"title":"Update RCS brand","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/rcs/brands/{id}","href":"/api-reference/all-endpoints/rcs/update-rcs-brand"},{"title":"Submit RCS brand for approval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/brands/{id}/submit","href":"/api-reference/all-endpoints/rcs/submit-rcs-brand-for-approval"},{"title":"List RCS bots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots","href":"/api-reference/all-endpoints/rcs/list-rcs-bots"},{"title":"Update RCS bot","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/rcs/bots","href":"/api-reference/all-endpoints/rcs/update-rcs-bot"},{"title":"Create RCS bot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots","href":"/api-reference/all-endpoints/rcs/create-rcs-bot"},{"title":"Get RCS bot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots/{id}","href":"/api-reference/all-endpoints/rcs/get-rcs-bot"},{"title":"Delete RCS bot","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/rcs/bots/{id}","href":"/api-reference/all-endpoints/rcs/delete-rcs-bot"},{"title":"Submit RCS bot for verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots/{id}/verify","href":"/api-reference/all-endpoints/rcs/submit-rcs-bot-for-verification"},{"title":"Submit RCS bot for launch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots/{id}/launch","href":"/api-reference/all-endpoints/rcs/submit-rcs-bot-for-launch"},{"title":"List RCS tester devices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots/{id}/devices","href":"/api-reference/all-endpoints/rcs/list-rcs-tester-devices"},{"title":"Add RCS tester device","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots/{id}/devices","href":"/api-reference/all-endpoints/rcs/add-rcs-tester-device"},{"title":"Remove RCS tester device","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/rcs/bots/{id}/devices","href":"/api-reference/all-endpoints/rcs/remove-rcs-tester-device"},{"title":"Send RCS tester invite","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots/{id}/tester-invite","href":"/api-reference/all-endpoints/rcs/send-rcs-tester-invite"},{"title":"List RCS templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots/{id}/templates","href":"/api-reference/all-endpoints/rcs/list-rcs-templates"},{"title":"Create RCS template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/bots/{id}/templates","href":"/api-reference/all-endpoints/rcs/create-rcs-template"},{"title":"Get RCS template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots/{id}/templates/{name}","href":"/api-reference/all-endpoints/rcs/get-rcs-template"},{"title":"Update RCS template","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/rcs/bots/{id}/templates/{name}","href":"/api-reference/all-endpoints/rcs/update-rcs-template"},{"title":"Delete RCS template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/rcs/bots/{id}/templates/{name}","href":"/api-reference/all-endpoints/rcs/delete-rcs-template"},{"title":"Check RCS capability","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/capability/{botId}/{phone}","href":"/api-reference/all-endpoints/rcs/check-rcs-capability"},{"title":"Get RCS bot quality","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/bots/{id}/quality","href":"/api-reference/all-endpoints/rcs/get-rcs-bot-quality"},{"title":"Get RCS template analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/analytics/templates","href":"/api-reference/all-endpoints/rcs/get-rcs-template-analytics"},{"title":"Get RCS daily analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/analytics/daily","href":"/api-reference/all-endpoints/rcs/get-rcs-daily-analytics"},{"title":"Scan RCS reach for a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/reach-scan","href":"/api-reference/all-endpoints/rcs/scan-rcs-reach-for-a-segment"},{"title":"List RCS commerce catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/commerce/catalog","href":"/api-reference/all-endpoints/rcs/list-rcs-commerce-catalog"},{"title":"Send RCS catalog carousel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/commerce/send-catalog","href":"/api-reference/all-endpoints/rcs/send-rcs-catalog-carousel"},{"title":"Get RCS test account status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/rcs/test-account/status","href":"/api-reference/all-endpoints/rcs/get-rcs-test-account-status"},{"title":"Send RCS test account OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/test-account/send-otp","href":"/api-reference/all-endpoints/rcs/send-rcs-test-account-otp"},{"title":"Verify RCS test account OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/test-account/verify-otp","href":"/api-reference/all-endpoints/rcs/verify-rcs-test-account-otp"},{"title":"Change RCS test account number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/rcs/test-account/change-number","href":"/api-reference/all-endpoints/rcs/change-rcs-test-account-number"}]},{"group":"Commerce","pages":[{"title":"Create cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart","href":"/api-reference/all-endpoints/commerce/create-cart"},{"title":"Merge a channel contribution into the cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart/merge","href":"/api-reference/all-endpoints/commerce/merge-a-channel-contribution-into-the-cart"},{"title":"Advance the checkout state machine","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart/transition","href":"/api-reference/all-endpoints/commerce/advance-the-checkout-state-machine"},{"title":"Reconcile a cross-channel payment against the cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart/reconcile-payment","href":"/api-reference/all-endpoints/commerce/reconcile-a-cross-channel-payment-against-the-cart"},{"title":"Select checkout-channel preference order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart/checkout-channel","href":"/api-reference/all-endpoints/commerce/select-checkout-channel-preference-order"},{"title":"Check whether the cart is abandoned","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/cart/abandonment-check","href":"/api-reference/all-endpoints/commerce/check-whether-the-cart-is-abandoned"},{"title":"Mint a hosted pay-by-link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/payment-request","href":"/api-reference/all-endpoints/commerce/mint-a-hosted-pay-by-link"},{"title":"Render a pay-by-link for one channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/payment-request/render","href":"/api-reference/all-endpoints/commerce/render-a-pay-by-link-for-one-channel"},{"title":"Advance a pay-by-link lifecycle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/payment-request/transition","href":"/api-reference/all-endpoints/commerce/advance-a-pay-by-link-lifecycle"},{"title":"Reconcile a captured PSP payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/payment-request/reconcile","href":"/api-reference/all-endpoints/commerce/reconcile-a-captured-psp-payment"},{"title":"Bind an in-call PCI capture to a commerce charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/secure-payment/charge","href":"/api-reference/all-endpoints/commerce/bind-an-in-call-pci-capture-to-a-commerce-charge"},{"title":"Resolve an in-thread WhatsApp checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/whatsapp-checkout","href":"/api-reference/all-endpoints/commerce/resolve-an-in-thread-whatsapp-checkout"},{"title":"Resolve an in-thread RCS checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/rcs-checkout","href":"/api-reference/all-endpoints/commerce/resolve-an-in-thread-rcs-checkout"},{"title":"Resolve an in-thread Apple Messages for Business checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/amb-checkout","href":"/api-reference/all-endpoints/commerce/resolve-an-in-thread-apple-messages-for-business-checkout"},{"title":"Resolve an in-conversation web-chat checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/webchat-checkout","href":"/api-reference/all-endpoints/commerce/resolve-an-in-conversation-web-chat-checkout"},{"title":"Issue an agent payment mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate","href":"/api-reference/all-endpoints/commerce/issue-an-agent-payment-mandate"},{"title":"Dry-run authorize a charge against a mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate/authorize","href":"/api-reference/all-endpoints/commerce/dry-run-authorize-a-charge-against-a-mandate"},{"title":"Authorize and commit a charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate/charge","href":"/api-reference/all-endpoints/commerce/authorize-and-commit-a-charge"},{"title":"Revoke a mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate/revoke","href":"/api-reference/all-endpoints/commerce/revoke-a-mandate"},{"title":"Verify mandate integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate/verify","href":"/api-reference/all-endpoints/commerce/verify-mandate-integrity"},{"title":"Mint a card-network agent payment token or trusted-agent credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agent-mandate/network-token","href":"/api-reference/all-endpoints/commerce/mint-a-card-network-agent-payment-token-or-trusted-agent-credential"},{"title":"Open an MPP pre-authorized session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/mpp-session","href":"/api-reference/all-endpoints/commerce/open-an-mpp-pre-authorized-session"},{"title":"Dry-run meter a call against an MPP session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/mpp-session/meter","href":"/api-reference/all-endpoints/commerce/dry-run-meter-a-call-against-an-mpp-session"},{"title":"Meter and settle one call streamed against an MPP session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/mpp-session/call","href":"/api-reference/all-endpoints/commerce/meter-and-settle-one-call-streamed-against-an-mpp-session"},{"title":"Revoke an MPP session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/mpp-session/revoke","href":"/api-reference/all-endpoints/commerce/revoke-an-mpp-session"},{"title":"Verify MPP session integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/mpp-session/verify","href":"/api-reference/all-endpoints/commerce/verify-mpp-session-integrity"},{"title":"Configure a DCB merchant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/merchant","href":"/api-reference/all-endpoints/commerce/configure-a-dcb-merchant"},{"title":"Initiate a DCB charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/charge","href":"/api-reference/all-endpoints/commerce/initiate-a-dcb-charge"},{"title":"Build the carrier-billing operator request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/operator-request","href":"/api-reference/all-endpoints/commerce/build-the-carrier-billing-operator-request"},{"title":"Capture a DCB charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/charge/capture","href":"/api-reference/all-endpoints/commerce/capture-a-dcb-charge"},{"title":"Fail a DCB charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/charge/fail","href":"/api-reference/all-endpoints/commerce/fail-a-dcb-charge"},{"title":"Refund a DCB charge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/charge/refund","href":"/api-reference/all-endpoints/commerce/refund-a-dcb-charge"},{"title":"Record a DCB chargeback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/charge/chargeback","href":"/api-reference/all-endpoints/commerce/record-a-dcb-chargeback"},{"title":"Reconcile a DCB settlement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/dcb/reconcile","href":"/api-reference/all-endpoints/commerce/reconcile-a-dcb-settlement"},{"title":"Build the ACP storefront manifest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agentic/manifest","href":"/api-reference/all-endpoints/commerce/build-the-acp-storefront-manifest"},{"title":"Build the ACP product feed","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agentic/feed","href":"/api-reference/all-endpoints/commerce/build-the-acp-product-feed"},{"title":"Open an ACP checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agentic/checkout","href":"/api-reference/all-endpoints/commerce/open-an-acp-checkout-session"},{"title":"Re-price an ACP checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agentic/checkout/update","href":"/api-reference/all-endpoints/commerce/re-price-an-acp-checkout-session"},{"title":"Complete an ACP checkout under a signed mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/agentic/checkout/complete","href":"/api-reference/all-endpoints/commerce/complete-an-acp-checkout-under-a-signed-mandate"},{"title":"Read the stored public ACP storefront config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/commerce/agentic/storefront","href":"/api-reference/all-endpoints/commerce/read-the-stored-public-acp-storefront-config"},{"title":"Publish/replace the public ACP storefront config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/commerce/agentic/storefront","href":"/api-reference/all-endpoints/commerce/publishreplace-the-public-acp-storefront-config"},{"title":"Build the UCP storefront manifest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/ucp/manifest","href":"/api-reference/all-endpoints/commerce/build-the-ucp-storefront-manifest"},{"title":"Build the UCP product catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/ucp/catalog","href":"/api-reference/all-endpoints/commerce/build-the-ucp-product-catalog"},{"title":"Open a UCP cart session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/ucp/cart","href":"/api-reference/all-endpoints/commerce/open-a-ucp-cart-session"},{"title":"Re-price a UCP cart session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/ucp/cart/update","href":"/api-reference/all-endpoints/commerce/re-price-a-ucp-cart-session"},{"title":"Complete a UCP cart under a signed mandate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/ucp/cart/complete","href":"/api-reference/all-endpoints/commerce/complete-a-ucp-cart-under-a-signed-mandate"},{"title":"Start a recurring subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions","href":"/api-reference/all-endpoints/commerce/start-a-recurring-subscription"},{"title":"Annotate + sort a set of subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions/list","href":"/api-reference/all-endpoints/commerce/annotate-+-sort-a-set-of-subscriptions"},{"title":"Pause a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions/pause","href":"/api-reference/all-endpoints/commerce/pause-a-subscription"},{"title":"Resume a paused subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions/resume","href":"/api-reference/all-endpoints/commerce/resume-a-paused-subscription"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions/cancel","href":"/api-reference/all-endpoints/commerce/cancel-a-subscription"},{"title":"Fire a due subscription renewal cycle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/commerce/subscriptions/renew","href":"/api-reference/all-endpoints/commerce/fire-a-due-subscription-renewal-cycle"}]},{"group":"Telegram","pages":[{"title":"Get Telegram channel state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/telegram/channel-state","href":"/api-reference/all-endpoints/telegram/get-telegram-channel-state"},{"title":"Start Telegram test verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/telegram/test/start-verify","href":"/api-reference/all-endpoints/telegram/start-telegram-test-verification"},{"title":"Send Telegram test message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/telegram/test/send","href":"/api-reference/all-endpoints/telegram/send-telegram-test-message"},{"title":"Disconnect Telegram test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/telegram/test/disconnect","href":"/api-reference/all-endpoints/telegram/disconnect-telegram-test"},{"title":"Connect Telegram bot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/telegram/connect-bot","href":"/api-reference/all-endpoints/telegram/connect-telegram-bot"},{"title":"Disconnect Telegram bot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/telegram/disconnect-bot","href":"/api-reference/all-endpoints/telegram/disconnect-telegram-bot"},{"title":"Get Telegram demo content","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/telegram/demo-content","href":"/api-reference/all-endpoints/telegram/get-telegram-demo-content"},{"title":"Get Telegram cost rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/telegram/analytics/costs","href":"/api-reference/all-endpoints/telegram/get-telegram-cost-rollup"}]},{"group":"USSD","pages":[{"title":"Get the configured USSD menu","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ussd/menu","href":"/api-reference/all-endpoints/ussd/get-the-configured-ussd-menu"},{"title":"Create or replace the USSD menu","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/ussd/menu","href":"/api-reference/all-endpoints/ussd/create-or-replace-the-ussd-menu"},{"title":"Simulate a USSD session step","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ussd/simulate","href":"/api-reference/all-endpoints/ussd/simulate-a-ussd-session-step"},{"title":"Get the USSD push-provider config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ussd/push/config","href":"/api-reference/all-endpoints/ussd/get-the-ussd-push-provider-config"},{"title":"Create or replace the USSD push-provider config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/ussd/push/config","href":"/api-reference/all-endpoints/ussd/create-or-replace-the-ussd-push-provider-config"},{"title":"Open a network-initiated (push) USSD session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ussd/push","href":"/api-reference/all-endpoints/ussd/open-a-network-initiated-push-ussd-session"},{"title":"USSD aggregator session callback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ussd/callback/{tenantId}","href":"/api-reference/all-endpoints/ussd/ussd-aggregator-session-callback"}]},{"group":"Files","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/files/upload","href":"/api-reference/all-endpoints/files/upload-a-file"},{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/files","href":"/api-reference/all-endpoints/files/list-files"},{"title":"Get a file by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/files/{id}","href":"/api-reference/all-endpoints/files/get-a-file-by-id"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/files/{id}","href":"/api-reference/all-endpoints/files/delete-a-file"},{"title":"Presign a file URL","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/files/{id}/presign","href":"/api-reference/all-endpoints/files/presign-a-file-url"},{"title":"Share a video with a permanent link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/files/{id}/share","href":"/api-reference/all-endpoints/files/share-a-video-with-a-permanent-link"},{"title":"Revoke a video's share links","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/files/{id}/share","href":"/api-reference/all-endpoints/files/revoke-a-videos-share-links"}]},{"group":"Recordings","pages":[{"title":"List legal-hold","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/legal-hold","href":"/api-reference/all-endpoints/recordings/list-legal-hold"},{"title":"Update legal-hold","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/recordings/{id}/legal-hold","href":"/api-reference/all-endpoints/recordings/update-legal-hold"},{"title":"List integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/integrity","href":"/api-reference/all-endpoints/recordings/list-integrity"},{"title":"List verify","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/integrity/verify","href":"/api-reference/all-endpoints/recordings/list-verify"},{"title":"List export-digest","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/integrity/export-digest","href":"/api-reference/all-endpoints/recordings/list-export-digest"},{"title":"Seal integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/integrity/seal","href":"/api-reference/all-endpoints/recordings/seal-integrity"},{"title":"Create screen-sync","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/screen-sync","href":"/api-reference/all-endpoints/recordings/create-screen-sync"},{"title":"List screen-recordings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/screen-recordings","href":"/api-reference/all-endpoints/recordings/list-screen-recordings"},{"title":"Create share","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/share","href":"/api-reference/all-endpoints/recordings/create-share"},{"title":"Delete share","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/recordings/{id}/share","href":"/api-reference/all-endpoints/recordings/delete-share"},{"title":"List clips","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/clips","href":"/api-reference/all-endpoints/recordings/list-clips"},{"title":"Create clips","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/clips","href":"/api-reference/all-endpoints/recordings/create-clips"},{"title":"Delete clips","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/recordings/{id}/clips/{clipId}","href":"/api-reference/all-endpoints/recordings/delete-clips"},{"title":"Detect highlight moments in a recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/highlights/detect","href":"/api-reference/all-endpoints/recordings/detect-highlight-moments-in-a-recording"},{"title":"List highlight moments for a recording","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/highlights","href":"/api-reference/all-endpoints/recordings/list-highlight-moments-for-a-recording"},{"title":"Promote a highlight moment to a recording clip","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/highlights/{momentId}/clip","href":"/api-reference/all-endpoints/recordings/promote-a-highlight-moment-to-a-recording-clip"},{"title":"Dismiss a highlight moment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/recordings/{id}/highlights/{momentId}","href":"/api-reference/all-endpoints/recordings/dismiss-a-highlight-moment"},{"title":"Export a recording transcript as a caption file (pseudonymized optional)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/transcript/export","href":"/api-reference/all-endpoints/recordings/export-a-recording-transcript-as-a-caption-file-pseudonymized-optional"},{"title":"List views","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/views","href":"/api-reference/all-endpoints/recordings/list-views"},{"title":"Create views","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/views","href":"/api-reference/all-endpoints/recordings/create-views"},{"title":"List report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/views/report","href":"/api-reference/all-endpoints/recordings/list-report"},{"title":"List desktop-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/desktop-analytics","href":"/api-reference/all-endpoints/recordings/list-desktop-analytics"},{"title":"Create desktop-analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/desktop-analytics","href":"/api-reference/all-endpoints/recordings/create-desktop-analytics"},{"title":"List visual-redactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/recordings/{id}/visual-redactions","href":"/api-reference/all-endpoints/recordings/list-visual-redactions"},{"title":"Create visual-redactions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/recordings/{id}/visual-redactions","href":"/api-reference/all-endpoints/recordings/create-visual-redactions"},{"title":"Delete visual-redactions","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/recordings/{id}/visual-redactions/{regionId}","href":"/api-reference/all-endpoints/recordings/delete-visual-redactions"}]},{"group":"Testing","pages":[{"title":"List status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/testing/status","href":"/api-reference/all-endpoints/testing/list-status"},{"title":"List networks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/testing/networks","href":"/api-reference/all-endpoints/testing/list-networks"},{"title":"Sender-id-test testing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/testing/sender-id-test","href":"/api-reference/all-endpoints/testing/sender-id-test-testing"},{"title":"List suppliers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/testing/suppliers","href":"/api-reference/all-endpoints/testing/list-suppliers"},{"title":"Get sender-id-test","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/testing/sender-id-test/{testId}","href":"/api-reference/all-endpoints/testing/get-sender-id-test"}]},{"group":"Links","pages":[{"title":"List landing pages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/landing-pages","href":"/api-reference/all-endpoints/links/list-landing-pages"},{"title":"Create a landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/links/landing-pages","href":"/api-reference/all-endpoints/links/create-a-landing-page"},{"title":"Get a landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/landing-pages/{id}","href":"/api-reference/all-endpoints/links/get-a-landing-page"},{"title":"Delete a landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/links/landing-pages/{id}","href":"/api-reference/all-endpoints/links/delete-a-landing-page"},{"title":"Update a landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/links/landing-pages/{id}","href":"/api-reference/all-endpoints/links/update-a-landing-page"},{"title":"Publish a landing page","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/links/landing-pages/{id}/publish","href":"/api-reference/all-endpoints/links/publish-a-landing-page"},{"title":"Get landing page analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/landing-pages/{id}/analytics","href":"/api-reference/all-endpoints/links/get-landing-page-analytics"},{"title":"List links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links","href":"/api-reference/all-endpoints/links/list-links"},{"title":"Create links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/links","href":"/api-reference/all-endpoints/links/create-links"},{"title":"List insights","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/insights","href":"/api-reference/all-endpoints/links/list-insights"},{"title":"Get per-campaign link-click analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/campaigns/{campaignId}/link-analytics","href":"/api-reference/all-endpoints/links/get-per-campaign-link-click-analytics"},{"title":"List clicks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/contacts/{contactId}/clicks","href":"/api-reference/all-endpoints/links/list-clicks"},{"title":"List stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/links/{id}/stats","href":"/api-reference/all-endpoints/links/list-stats"},{"title":"Delete links","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/links/{id}","href":"/api-reference/all-endpoints/links/delete-links"}]},{"group":"Sync","pages":[{"title":"Create a Sync Document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sync/documents","href":"/api-reference/all-endpoints/sync/create-a-sync-document"},{"title":"Get a Sync Document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sync/documents/{name}","href":"/api-reference/all-endpoints/sync/get-a-sync-document"},{"title":"Update a Sync Document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sync/documents/{name}","href":"/api-reference/all-endpoints/sync/update-a-sync-document"},{"title":"Delete a Sync Document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sync/documents/{name}","href":"/api-reference/all-endpoints/sync/delete-a-sync-document"},{"title":"List Sync Map items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sync/maps/{name}/items","href":"/api-reference/all-endpoints/sync/list-sync-map-items"},{"title":"Get a Sync Map item","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sync/maps/{name}/items/{key}","href":"/api-reference/all-endpoints/sync/get-a-sync-map-item"},{"title":"Set a Sync Map item","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/sync/maps/{name}/items/{key}","href":"/api-reference/all-endpoints/sync/set-a-sync-map-item"},{"title":"Remove a Sync Map item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sync/maps/{name}/items/{key}","href":"/api-reference/all-endpoints/sync/remove-a-sync-map-item"},{"title":"Delete a Sync Map","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sync/maps/{name}","href":"/api-reference/all-endpoints/sync/delete-a-sync-map"},{"title":"List Sync List items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sync/lists/{name}/items","href":"/api-reference/all-endpoints/sync/list-sync-list-items"},{"title":"Append a Sync List item","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sync/lists/{name}/items","href":"/api-reference/all-endpoints/sync/append-a-sync-list-item"},{"title":"Set a Sync List item","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/sync/lists/{name}/items/{index}","href":"/api-reference/all-endpoints/sync/set-a-sync-list-item"},{"title":"Remove a Sync List item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sync/lists/{name}/items/{index}","href":"/api-reference/all-endpoints/sync/remove-a-sync-list-item"},{"title":"Delete a Sync List","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sync/lists/{name}","href":"/api-reference/all-endpoints/sync/delete-a-sync-list"},{"title":"Publish a Sync Stream message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sync/streams/{name}/messages","href":"/api-reference/all-endpoints/sync/publish-a-sync-stream-message"}]},{"group":"QR","pages":[{"title":"Generate a QR code for arbitrary data","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/qr/generate","href":"/api-reference/all-endpoints/qr/generate-a-qr-code-for-arbitrary-data"},{"title":"Generate a WhatsApp click-to-chat QR code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/qr/whatsapp","href":"/api-reference/all-endpoints/qr/generate-a-whatsapp-click-to-chat-qr-code"},{"title":"Generate an SMS deep-link QR code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/qr/sms","href":"/api-reference/all-endpoints/qr/generate-an-sms-deep-link-qr-code"}]},{"group":"Ads","pages":[{"title":"Exchange oauth","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/oauth/exchange","href":"/api-reference/all-endpoints/ads/exchange-oauth"},{"title":"Connect a Meta ad account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/connect","href":"/api-reference/all-endpoints/ads/connect-a-meta-ad-account"},{"title":"List status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ads/status","href":"/api-reference/all-endpoints/ads/list-status"},{"title":"Delete disconnect","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/ads/disconnect","href":"/api-reference/all-endpoints/ads/delete-disconnect"},{"title":"List ad campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ads/campaigns","href":"/api-reference/all-endpoints/ads/list-ad-campaigns"},{"title":"Create an ad campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/campaigns","href":"/api-reference/all-endpoints/ads/create-an-ad-campaign"},{"title":"Get an ad campaign with insights","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ads/campaigns/{id}","href":"/api-reference/all-endpoints/ads/get-an-ad-campaign-with-insights"},{"title":"Update an ad campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/ads/campaigns/{id}","href":"/api-reference/all-endpoints/ads/update-an-ad-campaign"},{"title":"Delete an ad campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/ads/campaigns/{id}","href":"/api-reference/all-endpoints/ads/delete-an-ad-campaign"},{"title":"Set the Conversions API dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/ads/conversions/dataset","href":"/api-reference/all-endpoints/ads/set-the-conversions-api-dataset"},{"title":"Update auto-forward","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/ads/conversions/auto-forward","href":"/api-reference/all-endpoints/ads/update-auto-forward"},{"title":"Send a test conversion event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/conversions/test","href":"/api-reference/all-endpoints/ads/send-a-test-conversion-event"},{"title":"Conversions ads","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/conversions","href":"/api-reference/all-endpoints/ads/conversions-ads"},{"title":"List attribution","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ads/ctwa/attribution","href":"/api-reference/all-endpoints/ads/list-attribution"},{"title":"Ingest leads","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/leads/ingest","href":"/api-reference/all-endpoints/ads/ingest-leads"},{"title":"List custom audiences","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/ads/audiences","href":"/api-reference/all-endpoints/ads/list-custom-audiences"},{"title":"Create a custom audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/audiences","href":"/api-reference/all-endpoints/ads/create-a-custom-audience"},{"title":"Sync a segment to a custom audience","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/ads/audiences/{audienceId}/sync","href":"/api-reference/all-endpoints/ads/sync-a-segment-to-a-custom-audience"},{"title":"Delete a custom audience","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/ads/audiences/{audienceId}","href":"/api-reference/all-endpoints/ads/delete-a-custom-audience"}]},{"group":"Push","pages":[{"title":"List registered device tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/device-tokens","href":"/api-reference/all-endpoints/push/list-registered-device-tokens"},{"title":"Register a device token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/device-tokens","href":"/api-reference/all-endpoints/push/register-a-device-token"},{"title":"Register a device token (alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/register","href":"/api-reference/all-endpoints/push/register-a-device-token-alias"},{"title":"Delete a device token","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/push/device-tokens/{id}","href":"/api-reference/all-endpoints/push/delete-a-device-token"},{"title":"Enable or disable a device token","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/push/device-tokens/{id}","href":"/api-reference/all-endpoints/push/enable-or-disable-a-device-token"},{"title":"Get web push configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/config","href":"/api-reference/all-endpoints/push/get-web-push-configuration"},{"title":"Send a push notification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/send","href":"/api-reference/all-endpoints/push/send-a-push-notification"},{"title":"Send a push configuration test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/test-send","href":"/api-reference/all-endpoints/push/send-a-push-configuration-test"},{"title":"List sent push notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/notifications","href":"/api-reference/all-endpoints/push/list-sent-push-notifications"},{"title":"Acknowledge a push notification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/notifications/{id}/ack","href":"/api-reference/all-endpoints/push/acknowledge-a-push-notification"},{"title":"Clear a user's push badge count","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/badge/clear","href":"/api-reference/all-endpoints/push/clear-a-users-push-badge-count"},{"title":"List Live Activities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/live-activities","href":"/api-reference/all-endpoints/push/list-live-activities"},{"title":"Start a Live Activity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/live-activities","href":"/api-reference/all-endpoints/push/start-a-live-activity"},{"title":"Update a Live Activity","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/push/live-activities/{id}","href":"/api-reference/all-endpoints/push/update-a-live-activity"},{"title":"End a Live Activity","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/push/live-activities/{id}","href":"/api-reference/all-endpoints/push/end-a-live-activity"},{"title":"List push notification categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/categories","href":"/api-reference/all-endpoints/push/list-push-notification-categories"},{"title":"Create a push notification category","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/categories","href":"/api-reference/all-endpoints/push/create-a-push-notification-category"},{"title":"Get push notification category by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/categories/{id}","href":"/api-reference/all-endpoints/push/get-push-notification-category-by-id"},{"title":"Delete push notification category","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/push/categories/{id}","href":"/api-reference/all-endpoints/push/delete-push-notification-category"},{"title":"List scheduled push notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/scheduled","href":"/api-reference/all-endpoints/push/list-scheduled-push-notifications"},{"title":"Get a scheduled push notification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/scheduled/{id}","href":"/api-reference/all-endpoints/push/get-a-scheduled-push-notification"},{"title":"Cancel a scheduled push notification","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/push/scheduled/{id}","href":"/api-reference/all-endpoints/push/cancel-a-scheduled-push-notification"},{"title":"Report device-side push wake telemetry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/telemetry","href":"/api-reference/all-endpoints/push/report-device-side-push-wake-telemetry"},{"title":"Summarize device push telemetry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/telemetry/summary","href":"/api-reference/all-endpoints/push/summarize-device-push-telemetry"},{"title":"List registered VoIP call-push devices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/push/voip-devices","href":"/api-reference/all-endpoints/push/list-registered-voip-call-push-devices"},{"title":"Register a VoIP (PushKit) / high-priority FCM call token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/push/voip-devices","href":"/api-reference/all-endpoints/push/register-a-voip-pushkit-high-priority-fcm-call-token"},{"title":"Unregister a VoIP call-push device","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/push/voip-devices/{id}","href":"/api-reference/all-endpoints/push/unregister-a-voip-call-push-device"}]},{"group":"Subaccounts","pages":[{"title":"List subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts","href":"/api-reference/all-endpoints/subaccounts/list-subaccounts"},{"title":"Create subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts","href":"/api-reference/all-endpoints/subaccounts/create-subaccounts"},{"title":"Provision a subaccount in one call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/provision","href":"/api-reference/all-endpoints/subaccounts/provision-a-subaccount-in-one-call"},{"title":"Get subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}","href":"/api-reference/all-endpoints/subaccounts/get-subaccounts"},{"title":"Update subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}","href":"/api-reference/all-endpoints/subaccounts/update-subaccounts"},{"title":"Delete subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/subaccounts/{id}","href":"/api-reference/all-endpoints/subaccounts/delete-subaccounts"},{"title":"Suspend a subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/suspend","href":"/api-reference/all-endpoints/subaccounts/suspend-a-subaccount"},{"title":"Reactivate a suspended subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/reactivate","href":"/api-reference/all-endpoints/subaccounts/reactivate-a-suspended-subaccount"},{"title":"Finalize a pending subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/finalize","href":"/api-reference/all-endpoints/subaccounts/finalize-a-pending-subaccount"},{"title":"List export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/usage-rollup/export.csv","href":"/api-reference/all-endpoints/subaccounts/list-exportcsv"},{"title":"Consolidated usage rollup across the subaccount tree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/usage-rollup","href":"/api-reference/all-endpoints/subaccounts/consolidated-usage-rollup-across-the-subaccount-tree"},{"title":"List byo-fee-meter","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/byo-fee-meter","href":"/api-reference/all-endpoints/subaccounts/list-byo-fee-meter"},{"title":"Get a subaccount's lifetime usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/usage","href":"/api-reference/all-endpoints/subaccounts/get-a-subaccounts-lifetime-usage"},{"title":"List export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/usage/export.csv","href":"/api-reference/all-endpoints/subaccounts/list-exportcsv-1"},{"title":"List statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/usage/statement","href":"/api-reference/all-endpoints/subaccounts/list-statement"},{"title":"List invoice.html","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/invoice.html","href":"/api-reference/all-endpoints/subaccounts/list-invoicehtml"},{"title":"List live","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/usage/live","href":"/api-reference/all-endpoints/subaccounts/list-live"},{"title":"List api-keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/api-keys","href":"/api-reference/all-endpoints/subaccounts/list-api-keys"},{"title":"Create api-keys","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/api-keys","href":"/api-reference/all-endpoints/subaccounts/create-api-keys"},{"title":"Delete api-keys","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/subaccounts/{id}/api-keys/{keyId}","href":"/api-reference/all-endpoints/subaccounts/delete-api-keys"},{"title":"Transfer wallet credits to a subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/transfer-credits","href":"/api-reference/all-endpoints/subaccounts/transfer-wallet-credits-to-a-subaccount"},{"title":"List branding","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/branding","href":"/api-reference/all-endpoints/subaccounts/list-branding"},{"title":"Update branding","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/branding","href":"/api-reference/all-endpoints/subaccounts/update-branding"},{"title":"List notification-email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/notification-email","href":"/api-reference/all-endpoints/subaccounts/list-notification-email"},{"title":"Update notification-email","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/notification-email","href":"/api-reference/all-endpoints/subaccounts/update-notification-email"},{"title":"List domains","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/domains","href":"/api-reference/all-endpoints/subaccounts/list-domains"},{"title":"Create domains","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/domains","href":"/api-reference/all-endpoints/subaccounts/create-domains"},{"title":"List cname-target","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/domains/cname-target","href":"/api-reference/all-endpoints/subaccounts/list-cname-target"},{"title":"Delete domains","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/subaccounts/{id}/domains/{domainId}","href":"/api-reference/all-endpoints/subaccounts/delete-domains"},{"title":"Re-check a custom domain's CNAME","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/domains/{domainId}/verify","href":"/api-reference/all-endpoints/subaccounts/re-check-a-custom-domains-cname"},{"title":"Get a subaccount's reseller pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/pricing","href":"/api-reference/all-endpoints/subaccounts/get-a-subaccounts-reseller-pricing"},{"title":"Set a subaccount's reseller pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/pricing","href":"/api-reference/all-endpoints/subaccounts/set-a-subaccounts-reseller-pricing"},{"title":"List channel-budgets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/channel-budgets","href":"/api-reference/all-endpoints/subaccounts/list-channel-budgets"},{"title":"Update channel-budgets","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/channel-budgets","href":"/api-reference/all-endpoints/subaccounts/update-channel-budgets"},{"title":"Create channel-budgets","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/channel-budgets","href":"/api-reference/all-endpoints/subaccounts/create-channel-budgets"},{"title":"List the parent org's persisted rate cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/rate-cards","href":"/api-reference/all-endpoints/subaccounts/list-the-parent-orgs-persisted-rate-cards"},{"title":"Replace the parent org's rate-card library","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/rate-cards","href":"/api-reference/all-endpoints/subaccounts/replace-the-parent-orgs-rate-card-library"},{"title":"Update assigned-rate-card","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/assigned-rate-card","href":"/api-reference/all-endpoints/subaccounts/update-assigned-rate-card"},{"title":"Get a subaccount's AI configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/ai-config","href":"/api-reference/all-endpoints/subaccounts/get-a-subaccounts-ai-configuration"},{"title":"Update a subaccount's AI configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/ai-config","href":"/api-reference/all-endpoints/subaccounts/update-a-subaccounts-ai-configuration"},{"title":"Get the subaccount's reseller rate deck","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/rate-deck","href":"/api-reference/all-endpoints/subaccounts/get-the-subaccounts-reseller-rate-deck"},{"title":"Replace the subaccount's reseller rate deck","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/subaccounts/{id}/rate-deck","href":"/api-reference/all-endpoints/subaccounts/replace-the-subaccounts-reseller-rate-deck"},{"title":"List a subaccount's MCCMNC rate overrides","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/subaccounts/{id}/mccmnc-overrides","href":"/api-reference/all-endpoints/subaccounts/list-a-subaccounts-mccmnc-rate-overrides"},{"title":"Upsert a subaccount MCCMNC rate override","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/subaccounts/{id}/mccmnc-overrides","href":"/api-reference/all-endpoints/subaccounts/upsert-a-subaccount-mccmnc-rate-override"},{"title":"Delete a subaccount MCCMNC rate override","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/subaccounts/{id}/mccmnc-overrides/{overrideId}","href":"/api-reference/all-endpoints/subaccounts/delete-a-subaccount-mccmnc-rate-override"}]},{"group":"Branding","pages":[{"title":"List effective","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/branding/effective","href":"/api-reference/all-endpoints/branding/list-effective"}]},{"group":"Developer","pages":[{"title":"List received inbound webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/inbound-webhooks","href":"/api-reference/all-endpoints/developer/list-received-inbound-webhooks"},{"title":"Get an inbound webhook by id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/inbound-webhooks/{id}","href":"/api-reference/all-endpoints/developer/get-an-inbound-webhook-by-id"},{"title":"Get the event-streaming sink config for one kind","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/event-sinks/{kind}","href":"/api-reference/all-endpoints/developer/get-the-event-streaming-sink-config-for-one-kind"},{"title":"Update the event-streaming sink config for one kind","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/developer/event-sinks/{kind}","href":"/api-reference/all-endpoints/developer/update-the-event-streaming-sink-config-for-one-kind"},{"title":"Get the inbound event-source config for one kind","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/event-sources/{kind}","href":"/api-reference/all-endpoints/developer/get-the-inbound-event-source-config-for-one-kind"},{"title":"Update the inbound event-source config for one kind","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/developer/event-sources/{kind}","href":"/api-reference/all-endpoints/developer/update-the-inbound-event-source-config-for-one-kind"},{"title":"Dry-run one polled batch through the inbound consume core","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/developer/event-sources/{kind}/consume-batch","href":"/api-reference/all-endpoints/developer/dry-run-one-polled-batch-through-the-inbound-consume-core"},{"title":"View API rate-limit \u0026 quota governance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/governance","href":"/api-reference/all-endpoints/developer/view-api-rate-limit-\u0026-quota-governance"},{"title":"Set org-wide API rate-limit \u0026 spend governance default","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/developer/governance/org","href":"/api-reference/all-endpoints/developer/set-org-wide-api-rate-limit-\u0026-spend-governance-default"},{"title":"Set per-API-key rate-limit \u0026 spend override","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/developer/governance/keys/{keyId}","href":"/api-reference/all-endpoints/developer/set-per-api-key-rate-limit-\u0026-spend-override"},{"title":"View per-API-key spend budgets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/budgets","href":"/api-reference/all-endpoints/developer/view-per-api-key-spend-budgets"},{"title":"Set per-API-key spend budget","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/developer/budgets/{keyId}","href":"/api-reference/all-endpoints/developer/set-per-api-key-spend-budget"},{"title":"Run a GraphQL query over CPaaS/CDP resources","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/developer/graphql","href":"/api-reference/all-endpoints/developer/run-a-graphql-query-over-cpaascdp-resources"},{"title":"Download the developer GraphQL schema (SDL)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/graphql/schema","href":"/api-reference/all-endpoints/developer/download-the-developer-graphql-schema-sdl"},{"title":"Proxy an API request from the try-it console","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/developer/try-it","href":"/api-reference/all-endpoints/developer/proxy-an-api-request-from-the-try-it-console"},{"title":"Register interest in the Network APIs early-access program","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/developer/network-apis/early-access","href":"/api-reference/all-endpoints/developer/register-interest-in-the-network-apis-early-access-program"},{"title":"List official SDK libraries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/sdks","href":"/api-reference/all-endpoints/developer/list-official-sdk-libraries"},{"title":"List dated API versions and deprecation lifecycle","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/api-versions","href":"/api-reference/all-endpoints/developer/list-dated-api-versions-and-deprecation-lifecycle"},{"title":"Get API usage statistics for the current tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developer/usage-stats","href":"/api-reference/all-endpoints/developer/get-api-usage-statistics-for-the-current-tenant"},{"title":"Download a Postman collection for this workspace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/postman-collection","href":"/api-reference/all-endpoints/developer/download-a-postman-collection-for-this-workspace"},{"title":"Download a Postman environment for this workspace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/postman-environment","href":"/api-reference/all-endpoints/developer/download-a-postman-environment-for-this-workspace"},{"title":"Download the AsyncAPI contract for platform events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/asyncapi.json","href":"/api-reference/all-endpoints/developer/download-the-asyncapi-contract-for-platform-events"},{"title":"Download the Zapier app definition","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/connector/zapier","href":"/api-reference/all-endpoints/developer/download-the-zapier-app-definition"},{"title":"Download the Make (Integromat) app blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/connector/make","href":"/api-reference/all-endpoints/developer/download-the-make-integromat-app-blueprint"},{"title":"Download the n8n node-pack definition","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/connector/n8n","href":"/api-reference/all-endpoints/developer/download-the-n8n-node-pack-definition"},{"title":"List connector triggers and actions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/connector/catalog","href":"/api-reference/all-endpoints/developer/list-connector-triggers-and-actions"},{"title":"List grantable OAuth scopes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/oauth/scopes","href":"/api-reference/all-endpoints/developer/list-grantable-oauth-scopes"},{"title":"Preview the consent screen for a scope request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/oauth/consent-preview","href":"/api-reference/all-endpoints/developer/preview-the-consent-screen-for-a-scope-request"},{"title":"Download the OAuth app-registration manifest","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/oauth/manifest","href":"/api-reference/all-endpoints/developer/download-the-oauth-app-registration-manifest"},{"title":"List available CDP client tracking SDKs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/cdp-sdk/catalog","href":"/api-reference/all-endpoints/developer/list-available-cdp-client-tracking-sdks"},{"title":"Download a CDP client SDK source for a platform","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/cdp-sdk/source/{platform}","href":"/api-reference/all-endpoints/developer/download-a-cdp-client-sdk-source-for-a-platform"},{"title":"API analytics overview","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/api-analytics/overview","href":"/api-reference/all-endpoints/developer/api-analytics-overview"},{"title":"API analytics by endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/api-analytics/endpoints","href":"/api-reference/all-endpoints/developer/api-analytics-by-endpoint"},{"title":"API analytics time series","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/api-analytics/timeseries","href":"/api-reference/all-endpoints/developer/api-analytics-time-series"},{"title":"API analytics rate-limit usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/api-analytics/rate-limits","href":"/api-reference/all-endpoints/developer/api-analytics-rate-limit-usage"},{"title":"API analytics by API key","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/developers/api-analytics/by-key","href":"/api-reference/all-endpoints/developer/api-analytics-by-api-key"},{"title":"Ask-Orbit — natural-language API analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/developers/api-analytics/ask","href":"/api-reference/all-endpoints/developer/ask-orbit-—-natural-language-api-analytics"},{"title":"Download the OpenAPI contract","deprecated":null,"version":null,"openapi":"/openapi.yaml get /openapi.json","href":"/api-reference/all-endpoints/developer/download-the-openapi-contract"},{"title":"Download the OpenAPI contract","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/openapi.json","href":"/api-reference/all-endpoints/developer/download-the-openapi-contract-1"}]},{"group":"Tail","pages":[{"title":"List tail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/tail","href":"/api-reference/all-endpoints/tail/list-tail"}]},{"group":"Sandbox","pages":[{"title":"List the sandbox magic-number table","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sandbox/numbers","href":"/api-reference/all-endpoints/sandbox/list-the-sandbox-magic-number-table"},{"title":"Reset sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sandbox/reset","href":"/api-reference/all-endpoints/sandbox/reset-sandbox"},{"title":"Provision-numbers sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sandbox/provision-numbers","href":"/api-reference/all-endpoints/sandbox/provision-numbers-sandbox"},{"title":"Spawn-fixture-contacts sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sandbox/spawn-fixture-contacts","href":"/api-reference/all-endpoints/sandbox/spawn-fixture-contacts-sandbox"},{"title":"Inbound sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sandbox/inbound","href":"/api-reference/all-endpoints/sandbox/inbound-sandbox"},{"title":"Evaluate the shared pre-launch checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sandbox/pre-launch-checklist","href":"/api-reference/all-endpoints/sandbox/evaluate-the-shared-pre-launch-checklist"}]},{"group":"Proxy","pages":[{"title":"Inbound proxy webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/proxy/inbound","href":"/api-reference/all-endpoints/proxy/inbound-proxy-webhook"},{"title":"List proxy sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/sessions","href":"/api-reference/all-endpoints/proxy/list-proxy-sessions"},{"title":"Create proxy session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/proxy/sessions","href":"/api-reference/all-endpoints/proxy/create-proxy-session"},{"title":"Get proxy session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/sessions/{id}","href":"/api-reference/all-endpoints/proxy/get-proxy-session"},{"title":"Close proxy session","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/proxy/sessions/{id}","href":"/api-reference/all-endpoints/proxy/close-proxy-session"},{"title":"List registered prefixes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/prefixes","href":"/api-reference/all-endpoints/proxy/list-registered-prefixes"},{"title":"Register a BYO IP prefix announcement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/proxy/prefixes","href":"/api-reference/all-endpoints/proxy/register-a-byo-ip-prefix-announcement"},{"title":"Get a registered prefix","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/prefixes/{id}","href":"/api-reference/all-endpoints/proxy/get-a-registered-prefix"},{"title":"Read failover group status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/prefixes/{id}/failover","href":"/api-reference/all-endpoints/proxy/read-failover-group-status"},{"title":"Configure BGP failover pairing","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/proxy/prefixes/{id}/failover","href":"/api-reference/all-endpoints/proxy/configure-bgp-failover-pairing"},{"title":"Read fencing policy + violation ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/proxy/prefixes/{id}/policy","href":"/api-reference/all-endpoints/proxy/read-fencing-policy-+-violation-ledger"},{"title":"Configure traffic-fencing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/proxy/prefixes/{id}/policy","href":"/api-reference/all-endpoints/proxy/configure-traffic-fencing-policy"},{"title":"Report a fencing violation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/proxy/prefixes/{id}/violations","href":"/api-reference/all-endpoints/proxy/report-a-fencing-violation"},{"title":"Report prefix health","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/proxy/prefixes/{id}/health","href":"/api-reference/all-endpoints/proxy/report-prefix-health"}]},{"group":"Conversations","pages":[{"title":"List all conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations","href":"/api-reference/all-endpoints/conversations/list-all-conversations"},{"title":"Search the archived conversation archive","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/archive/search","href":"/api-reference/all-endpoints/conversations/search-the-archived-conversation-archive"},{"title":"Export inbox conversations (CSV or JSON)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/export","href":"/api-reference/all-endpoints/conversations/export-inbox-conversations-csv-or-json"},{"title":"Export a conversation as a signed IETF vCon","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/vcon","href":"/api-reference/all-endpoints/conversations/export-a-conversation-as-a-signed-ietf-vcon"},{"title":"Import a signed IETF vCon as a new conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/import-vcon","href":"/api-reference/all-endpoints/conversations/import-a-signed-ietf-vcon-as-a-new-conversation"},{"title":"List distinct conversation tags for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/tags/distinct","href":"/api-reference/all-endpoints/conversations/list-distinct-conversation-tags-for-the-tenant"},{"title":"Silently watch a live digital conversation (listen)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/monitor/watch","href":"/api-reference/all-endpoints/conversations/silently-watch-a-live-digital-conversation-listen"},{"title":"Whisper a private coaching tip to the handling agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/monitor/whisper","href":"/api-reference/all-endpoints/conversations/whisper-a-private-coaching-tip-to-the-handling-agent"},{"title":"Barge into a digital conversation (seize reply control)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/monitor/barge","href":"/api-reference/all-endpoints/conversations/barge-into-a-digital-conversation-seize-reply-control"},{"title":"Stop watching a digital conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/monitor/unwatch","href":"/api-reference/all-endpoints/conversations/stop-watching-a-digital-conversation"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}","href":"/api-reference/all-endpoints/conversations/get-a-conversation"},{"title":"Permanently delete a conversation (owner/admin only)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/conversations/{id}","href":"/api-reference/all-endpoints/conversations/permanently-delete-a-conversation-owneradmin-only"},{"title":"Get conversation messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/messages","href":"/api-reference/all-endpoints/conversations/get-conversation-messages"},{"title":"Conversation activity feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/activity","href":"/api-reference/all-endpoints/conversations/conversation-activity-feed"},{"title":"Get live cost breakdown for one conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/cost","href":"/api-reference/all-endpoints/conversations/get-live-cost-breakdown-for-one-conversation"},{"title":"Per-message sentiment timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/sentiment-timeline","href":"/api-reference/all-endpoints/conversations/per-message-sentiment-timeline"},{"title":"Live conversation outcome / predicted-CSAT scoring","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/outcome-prediction","href":"/api-reference/all-endpoints/conversations/live-conversation-outcome-predicted-csat-scoring"},{"title":"Reply in a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/reply","href":"/api-reference/all-endpoints/conversations/reply-in-a-conversation"},{"title":"Resolve the outbound sender a reply will use","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/reply-sender","href":"/api-reference/all-endpoints/conversations/resolve-the-outbound-sender-a-reply-will-use"},{"title":"Assign conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/assign","href":"/api-reference/all-endpoints/conversations/assign-conversation"},{"title":"Accept an offered conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/assignment/accept","href":"/api-reference/all-endpoints/conversations/accept-an-offered-conversation"},{"title":"Decline an offered conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/assignment/decline","href":"/api-reference/all-endpoints/conversations/decline-an-offered-conversation"},{"title":"Agent Copilot — suggest replies + next-best-actions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/copilot/suggest","href":"/api-reference/all-endpoints/conversations/agent-copilot-—-suggest-replies-+-next-best-actions"},{"title":"Handoff conversation from AI to a human","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/handoff","href":"/api-reference/all-endpoints/conversations/handoff-conversation-from-ai-to-a-human"},{"title":"Get current queue position for an in-flight handoff","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/handoff/queue-position","href":"/api-reference/all-endpoints/conversations/get-current-queue-position-for-an-in-flight-handoff"},{"title":"Get the full handoff packet for an in-flight AI conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/handoff/packet","href":"/api-reference/all-endpoints/conversations/get-the-full-handoff-packet-for-an-in-flight-ai-conversation"},{"title":"Escalate conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/escalate","href":"/api-reference/all-endpoints/conversations/escalate-conversation"},{"title":"Update conversation tags","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/conversations/{id}/tags","href":"/api-reference/all-endpoints/conversations/update-conversation-tags"},{"title":"Re-run conversation intelligence on an inbox thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/analyze-intelligence","href":"/api-reference/all-endpoints/conversations/re-run-conversation-intelligence-on-an-inbox-thread"},{"title":"Get conversation custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/custom-fields","href":"/api-reference/all-endpoints/conversations/get-conversation-custom-fields"},{"title":"Replace conversation custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/conversations/{id}/custom-fields","href":"/api-reference/all-endpoints/conversations/replace-conversation-custom-fields"},{"title":"Create a public transcript share link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/share","href":"/api-reference/all-endpoints/conversations/create-a-public-transcript-share-link"},{"title":"Set conversation priority","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/conversations/{id}/priority","href":"/api-reference/all-endpoints/conversations/set-conversation-priority"},{"title":"Set outbound auto-translate for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/conversations/{id}/auto-translate","href":"/api-reference/all-endpoints/conversations/set-outbound-auto-translate-for-a-conversation"},{"title":"Close conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/close","href":"/api-reference/all-endpoints/conversations/close-conversation"},{"title":"Snooze conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/snooze","href":"/api-reference/all-endpoints/conversations/snooze-conversation"},{"title":"Reopen conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/reopen","href":"/api-reference/all-endpoints/conversations/reopen-conversation"},{"title":"Merge conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/merge","href":"/api-reference/all-endpoints/conversations/merge-conversations"},{"title":"Undo a recent conversation merge","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/unmerge","href":"/api-reference/all-endpoints/conversations/undo-a-recent-conversation-merge"},{"title":"List linked conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/links","href":"/api-reference/all-endpoints/conversations/list-linked-conversations"},{"title":"Link a related conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/links","href":"/api-reference/all-endpoints/conversations/link-a-related-conversation"},{"title":"Unlink a related conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/conversations/{id}/links/{linkId}","href":"/api-reference/all-endpoints/conversations/unlink-a-related-conversation"},{"title":"List conversation followers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/followers","href":"/api-reference/all-endpoints/conversations/list-conversation-followers"},{"title":"Follow a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/followers","href":"/api-reference/all-endpoints/conversations/follow-a-conversation"},{"title":"Unfollow a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/conversations/{id}/followers/{userId}","href":"/api-reference/all-endpoints/conversations/unfollow-a-conversation"},{"title":"Resume AI agent after human-in-the-loop handoff (hand back to bot)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/agent/resume","href":"/api-reference/all-endpoints/conversations/resume-ai-agent-after-human-in-the-loop-handoff-hand-back-to-bot"},{"title":"Continue a conversation on a different channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/resume-channel","href":"/api-reference/all-endpoints/conversations/continue-a-conversation-on-a-different-channel"},{"title":"Read agent_active state for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/agent/active","href":"/api-reference/all-endpoints/conversations/read-agent_active-state-for-a-conversation"},{"title":"Resolve AI handoff","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/handoff/resolve","href":"/api-reference/all-endpoints/conversations/resolve-ai-handoff"},{"title":"Bulk action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/bulk","href":"/api-reference/all-endpoints/conversations/bulk-action"},{"title":"Translate one message body to a target language","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/messages/{mid}/translate","href":"/api-reference/all-endpoints/conversations/translate-one-message-body-to-a-target-language"},{"title":"List side conversations for a parent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/side-conversations","href":"/api-reference/all-endpoints/conversations/list-side-conversations-for-a-parent"},{"title":"Create a side conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/side-conversations","href":"/api-reference/all-endpoints/conversations/create-a-side-conversation"},{"title":"Get side-conversation message thread","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/conversations/{id}/side-conversations/{sideId}/messages","href":"/api-reference/all-endpoints/conversations/get-side-conversation-message-thread"},{"title":"Reply in a side conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/side-conversations/{sideId}/reply","href":"/api-reference/all-endpoints/conversations/reply-in-a-side-conversation"},{"title":"Resolve a side conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/side-conversations/{sideId}/resolve","href":"/api-reference/all-endpoints/conversations/resolve-a-side-conversation"},{"title":"Reopen a resolved side conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/conversations/{id}/side-conversations/{sideId}/reopen","href":"/api-reference/all-endpoints/conversations/reopen-a-resolved-side-conversation"},{"title":"Open the conversation rating page","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/conversations/{token}/csat","href":"/api-reference/all-endpoints/conversations/open-the-conversation-rating-page"},{"title":"Submit a conversation rating (CSAT/NPS)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/conversations/{token}/csat","href":"/api-reference/all-endpoints/conversations/submit-a-conversation-rating-csatnps"},{"title":"List interactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/interactions","href":"/api-reference/all-endpoints/conversations/list-interactions"},{"title":"List export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/interactions/export.csv","href":"/api-reference/all-endpoints/conversations/list-exportcsv"}]},{"group":"Cobrowse","pages":[{"title":"Get the co-browse capture-time privacy policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cobrowse/privacy","href":"/api-reference/all-endpoints/cobrowse/get-the-co-browse-capture-time-privacy-policy"},{"title":"Update the co-browse capture-time privacy policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/cobrowse/privacy","href":"/api-reference/all-endpoints/cobrowse/update-the-co-browse-capture-time-privacy-policy"},{"title":"Get the co-browse session for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/cobrowse/{conversationId}","href":"/api-reference/all-endpoints/cobrowse/get-the-co-browse-session-for-a-conversation"},{"title":"Join a live co-browse session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cobrowse/{conversationId}/join","href":"/api-reference/all-endpoints/cobrowse/join-a-live-co-browse-session"},{"title":"End a co-browse session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cobrowse/{conversationId}/end","href":"/api-reference/all-endpoints/cobrowse/end-a-co-browse-session"},{"title":"Send a guided-control packet (highlight / scroll / form-fill)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cobrowse/{conversationId}/control","href":"/api-reference/all-endpoints/cobrowse/send-a-guided-control-packet-highlight-scroll-form-fill"}]},{"group":"SessionReplay","pages":[{"title":"Get the session-replay capture-time privacy policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/session-replay/privacy","href":"/api-reference/all-endpoints/sessionreplay/get-the-session-replay-capture-time-privacy-policy"},{"title":"Update the session-replay capture-time privacy policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/session-replay/privacy","href":"/api-reference/all-endpoints/sessionreplay/update-the-session-replay-capture-time-privacy-policy"},{"title":"List recent session-replay recordings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/session-replay","href":"/api-reference/all-endpoints/sessionreplay/list-recent-session-replay-recordings"},{"title":"Get a session-replay recording for playback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/session-replay/{conversationId}","href":"/api-reference/all-endpoints/sessionreplay/get-a-session-replay-recording-for-playback"},{"title":"Delete a session-replay recording","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/session-replay/{conversationId}","href":"/api-reference/all-endpoints/sessionreplay/delete-a-session-replay-recording"},{"title":"List high-friction session replays ranked by frustration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/session-replay/frustration/sessions","href":"/api-reference/all-endpoints/sessionreplay/list-high-friction-session-replays-ranked-by-frustration"},{"title":"Get a session replay's frustration-signal timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/session-replay/frustration/{conversationId}","href":"/api-reference/all-endpoints/sessionreplay/get-a-session-replays-frustration-signal-timeline"}]},{"group":"Status Page","pages":[{"title":"List public status-page incidents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/incidents","href":"/api-reference/all-endpoints/status-page/list-public-status-page-incidents"},{"title":"Get a public status-page incident","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/incidents/{id}","href":"/api-reference/all-endpoints/status-page/get-a-public-status-page-incident"},{"title":"Get the status-page incident RSS feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/incidents.rss","href":"/api-reference/all-endpoints/status-page/get-the-status-page-incident-rss-feed"},{"title":"Subscribe to status-page incident emails","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/statuspage/subscribers","href":"/api-reference/all-endpoints/status-page/subscribe-to-status-page-incident-emails"},{"title":"Confirm a status-page email subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/statuspage/subscribers/confirm/{token}","href":"/api-reference/all-endpoints/status-page/confirm-a-status-page-email-subscription"},{"title":"Unsubscribe from status-page emails","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/statuspage/subscribers/unsubscribe/{token}","href":"/api-reference/all-endpoints/status-page/unsubscribe-from-status-page-emails"}]},{"group":"Help Center","pages":[{"title":"Get public help-center branding","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/branding","href":"/api-reference/all-endpoints/help-center/get-public-help-center-branding"},{"title":"List public help-center articles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/articles","href":"/api-reference/all-endpoints/help-center/list-public-help-center-articles"},{"title":"Get a public help-center article","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/articles/{slug}","href":"/api-reference/all-endpoints/help-center/get-a-public-help-center-article"},{"title":"Search public help-center articles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/search","href":"/api-reference/all-endpoints/help-center/search-public-help-center-articles"},{"title":"Submit help-center article feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/help/feedback","href":"/api-reference/all-endpoints/help-center/submit-help-center-article-feedback"},{"title":"Open a public help-center support ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/public/help/tickets","href":"/api-reference/all-endpoints/help-center/open-a-public-help-center-support-ticket"},{"title":"Get public help-center ticket status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/tickets/{id}","href":"/api-reference/all-endpoints/help-center/get-public-help-center-ticket-status"},{"title":"List public help-center categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/public/help/categories","href":"/api-reference/all-endpoints/help-center/list-public-help-center-categories"}]},{"group":"Content","pages":[{"title":"List pages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/content/pages","href":"/api-reference/all-endpoints/content/list-pages"},{"title":"Pages content","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/content/pages","href":"/api-reference/all-endpoints/content/pages-content"},{"title":"Delete pages","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/content/pages/{id}","href":"/api-reference/all-endpoints/content/delete-pages"}]},{"group":"Onboarding","pages":[{"title":"Get the getting-started checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/onboarding/status","href":"/api-reference/all-endpoints/onboarding/get-the-getting-started-checklist"},{"title":"Get the compliance status timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/onboarding/status-timeline","href":"/api-reference/all-endpoints/onboarding/get-the-compliance-status-timeline"},{"title":"Get the SMS getting-started checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/onboarding/sms-checklist","href":"/api-reference/all-endpoints/onboarding/get-the-sms-getting-started-checklist"},{"title":"Get workspace provisioning progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/onboarding/provisioning-status","href":"/api-reference/all-endpoints/onboarding/get-workspace-provisioning-progress"},{"title":"Mark an onboarding step complete","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/onboarding/complete-step","href":"/api-reference/all-endpoints/onboarding/mark-an-onboarding-step-complete"},{"title":"Skip an onboarding step","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/onboarding/skip-step","href":"/api-reference/all-endpoints/onboarding/skip-an-onboarding-step"},{"title":"Join the tenant that owns a white-label domain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/onboarding/whitelabel-join","href":"/api-reference/all-endpoints/onboarding/join-the-tenant-that-owns-a-white-label-domain"}]},{"group":"Imports","pages":[{"title":"Start the Twilio Connect authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/imports/twilio/connect","href":"/api-reference/all-endpoints/imports/start-the-twilio-connect-authorization"},{"title":"Complete the Twilio Connect authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/imports/twilio/callback","href":"/api-reference/all-endpoints/imports/complete-the-twilio-connect-authorization"},{"title":"Submit Twilio credentials manually","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/twilio/manual-credentials","href":"/api-reference/all-endpoints/imports/submit-twilio-credentials-manually"},{"title":"Submit Telnyx credentials manually","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/telnyx/manual-credentials","href":"/api-reference/all-endpoints/imports/submit-telnyx-credentials-manually"},{"title":"Submit Klaviyo credentials manually","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/klaviyo/manual-credentials","href":"/api-reference/all-endpoints/imports/submit-klaviyo-credentials-manually"},{"title":"Submit MessageBird credentials manually","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/messagebird/manual-credentials","href":"/api-reference/all-endpoints/imports/submit-messagebird-credentials-manually"},{"title":"Preview an import before running it","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/{source}/dry-run","href":"/api-reference/all-endpoints/imports/preview-an-import-before-running-it"},{"title":"Start an import job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/{source}/run","href":"/api-reference/all-endpoints/imports/start-an-import-job"},{"title":"List recent import jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/imports","href":"/api-reference/all-endpoints/imports/list-recent-import-jobs"},{"title":"Get an import job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/imports/{jobId}","href":"/api-reference/all-endpoints/imports/get-an-import-job"},{"title":"Cancel a running import job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/{jobId}/cancel","href":"/api-reference/all-endpoints/imports/cancel-a-running-import-job"},{"title":"Roll back a completed import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/imports/{jobId}/rollback","href":"/api-reference/all-endpoints/imports/roll-back-a-completed-import"},{"title":"Stream import job progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/imports/{jobId}/progress","href":"/api-reference/all-endpoints/imports/stream-import-job-progress"}]},{"group":"Referrals","pages":[{"title":"List referral programs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs","href":"/api-reference/all-endpoints/referrals/list-referral-programs"},{"title":"Create a referral program","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/referrals/programs","href":"/api-reference/all-endpoints/referrals/create-a-referral-program"},{"title":"Count referral programs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs/count","href":"/api-reference/all-endpoints/referrals/count-referral-programs"},{"title":"Get a referral program","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs/{id}","href":"/api-reference/all-endpoints/referrals/get-a-referral-program"},{"title":"Update a referral program","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/referrals/programs/{id}","href":"/api-reference/all-endpoints/referrals/update-a-referral-program"},{"title":"Delete a referral program","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/referrals/programs/{id}","href":"/api-reference/all-endpoints/referrals/delete-a-referral-program"},{"title":"Issue a referral code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/referrals/programs/{id}/codes","href":"/api-reference/all-endpoints/referrals/issue-a-referral-code"},{"title":"Get the referral leaderboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs/{id}/leaderboard","href":"/api-reference/all-endpoints/referrals/get-the-referral-leaderboard"},{"title":"Get program-wide referral totals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs/{id}/totals","href":"/api-reference/all-endpoints/referrals/get-program-wide-referral-totals"},{"title":"List referral conversions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/referrals/programs/{id}/conversions","href":"/api-reference/all-endpoints/referrals/list-referral-conversions"},{"title":"Pay a referral reward","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/referrals/programs/{id}/conversions/{conversionId}/pay","href":"/api-reference/all-endpoints/referrals/pay-a-referral-reward"}]},{"group":"Incentives","pages":[{"title":"List providers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/incentives/providers","href":"/api-reference/all-endpoints/incentives/list-providers"},{"title":"Get providers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/incentives/providers/{id}","href":"/api-reference/all-endpoints/incentives/get-providers"},{"title":"Issue incentives","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/incentives/issue","href":"/api-reference/all-endpoints/incentives/issue-incentives"},{"title":"List issued","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/incentives/issued","href":"/api-reference/all-endpoints/incentives/list-issued"},{"title":"Create redeem","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/incentives/{id}/redeem","href":"/api-reference/all-endpoints/incentives/create-redeem"},{"title":"Create void","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/incentives/{id}/void","href":"/api-reference/all-endpoints/incentives/create-void"}]},{"group":"WalletPasses","pages":[{"title":"List platforms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wallet-passes/platforms","href":"/api-reference/all-endpoints/walletpasses/list-platforms"},{"title":"Issue wallet-passes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wallet-passes/issue","href":"/api-reference/all-endpoints/walletpasses/issue-wallet-passes"},{"title":"List wallet-passes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wallet-passes","href":"/api-reference/all-endpoints/walletpasses/list-wallet-passes"},{"title":"Get wallet-passes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wallet-passes/{id}","href":"/api-reference/all-endpoints/walletpasses/get-wallet-passes"},{"title":"Create update","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wallet-passes/{id}/update","href":"/api-reference/all-endpoints/walletpasses/create-update"},{"title":"Create void","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wallet-passes/{id}/void","href":"/api-reference/all-endpoints/walletpasses/create-void"}]},{"group":"Personalization","pages":[{"title":"List personalization slots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/personalization/slots","href":"/api-reference/all-endpoints/personalization/list-personalization-slots"},{"title":"Create a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/personalization/slots","href":"/api-reference/all-endpoints/personalization/create-a-personalization-slot"},{"title":"Get a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/personalization/slots/{id}","href":"/api-reference/all-endpoints/personalization/get-a-personalization-slot"},{"title":"Delete a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/personalization/slots/{id}","href":"/api-reference/all-endpoints/personalization/delete-a-personalization-slot"},{"title":"Update a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/personalization/slots/{id}","href":"/api-reference/all-endpoints/personalization/update-a-personalization-slot"},{"title":"Preview a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/personalization/slots/{slot}/preview","href":"/api-reference/all-endpoints/personalization/preview-a-personalization-slot"},{"title":"Report lift for a personalization slot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/personalization/slots/{slot}/lift","href":"/api-reference/all-endpoints/personalization/report-lift-for-a-personalization-slot"}]},{"group":"Messaging","pages":[{"title":"Get LCR policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/lcr/policy","href":"/api-reference/all-endpoints/messaging/get-lcr-policy"},{"title":"Upsert LCR policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/messaging/lcr/policy","href":"/api-reference/all-endpoints/messaging/upsert-lcr-policy"},{"title":"Dry-run LCR quote preview","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/lcr/quote","href":"/api-reference/all-endpoints/messaging/dry-run-lcr-quote-preview"}]},{"group":"Messaging Services","pages":[{"title":"Get messaging data residency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/data-residency","href":"/api-reference/all-endpoints/messaging-services/get-messaging-data-residency"},{"title":"List messaging services","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services","href":"/api-reference/all-endpoints/messaging-services/list-messaging-services"},{"title":"Create messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/services","href":"/api-reference/all-endpoints/messaging-services/create-messaging-service"},{"title":"Look up messaging service by external id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/lookup","href":"/api-reference/all-endpoints/messaging-services/look-up-messaging-service-by-external-id"},{"title":"Get account messaging throughput stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/throughput-stats","href":"/api-reference/all-endpoints/messaging-services/get-account-messaging-throughput-stats"},{"title":"Get messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/{id}","href":"/api-reference/all-endpoints/messaging-services/get-messaging-service"},{"title":"Delete messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/services/{id}","href":"/api-reference/all-endpoints/messaging-services/delete-messaging-service"},{"title":"Update messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/services/{id}","href":"/api-reference/all-endpoints/messaging-services/update-messaging-service"},{"title":"Get messaging service throughput cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/{id}/throughput","href":"/api-reference/all-endpoints/messaging-services/get-messaging-service-throughput-cap"},{"title":"Update messaging service throughput cap","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/services/{id}/throughput","href":"/api-reference/all-endpoints/messaging-services/update-messaging-service-throughput-cap"},{"title":"Get messaging service throughput stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/{id}/throughput-stats","href":"/api-reference/all-endpoints/messaging-services/get-messaging-service-throughput-stats"},{"title":"List messaging service phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/services/{id}/phone-numbers","href":"/api-reference/all-endpoints/messaging-services/list-messaging-service-phone-numbers"},{"title":"Attach phone number to messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/services/{id}/phone-numbers","href":"/api-reference/all-endpoints/messaging-services/attach-phone-number-to-messaging-service"},{"title":"Detach phone number from messaging service","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/services/{id}/phone-numbers/{numberId}","href":"/api-reference/all-endpoints/messaging-services/detach-phone-number-from-messaging-service"}]},{"group":"SMPP","pages":[{"title":"List SMPP credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/credentials","href":"/api-reference/all-endpoints/smpp/list-smpp-credentials"},{"title":"Create SMPP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/smpp/credentials","href":"/api-reference/all-endpoints/smpp/create-smpp-credential"},{"title":"Get SMPP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/credentials/{id}","href":"/api-reference/all-endpoints/smpp/get-smpp-credential"},{"title":"Revoke SMPP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/smpp/credentials/{id}","href":"/api-reference/all-endpoints/smpp/revoke-smpp-credential"},{"title":"Update SMPP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/smpp/credentials/{id}","href":"/api-reference/all-endpoints/smpp/update-smpp-credential"},{"title":"Reveal SMPP credential password","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/credentials/{id}/reveal","href":"/api-reference/all-endpoints/smpp/reveal-smpp-credential-password"},{"title":"Rotate an SMPP credential's password and return the new plaintext once","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/smpp/credentials/{id}/rotate","href":"/api-reference/all-endpoints/smpp/rotate-an-smpp-credentials-password-and-return-the-new-plaintext-once"},{"title":"List SMPP carriers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/carriers","href":"/api-reference/all-endpoints/smpp/list-smpp-carriers"},{"title":"Create SMPP or HTTP-API carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/smpp/carriers","href":"/api-reference/all-endpoints/smpp/create-smpp-or-http-api-carrier"},{"title":"Get SMPP carrier route scores","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/carriers/route-scores","href":"/api-reference/all-endpoints/smpp/get-smpp-carrier-route-scores"},{"title":"Dry-run LCR route quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/smpp/carriers/route-quote","href":"/api-reference/all-endpoints/smpp/dry-run-lcr-route-quote"},{"title":"Get SMPP carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/smpp/carriers/{id}","href":"/api-reference/all-endpoints/smpp/get-smpp-carrier"},{"title":"Delete SMPP carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/smpp/carriers/{id}","href":"/api-reference/all-endpoints/smpp/delete-smpp-carrier"},{"title":"Update SMPP carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/smpp/carriers/{id}","href":"/api-reference/all-endpoints/smpp/update-smpp-carrier"},{"title":"Test SMPP carrier bind","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/smpp/carriers/{id}/test","href":"/api-reference/all-endpoints/smpp/test-smpp-carrier-bind"}]},{"group":"Sender Pools","pages":[{"title":"List sender pools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/sender-pools","href":"/api-reference/all-endpoints/sender-pools/list-sender-pools"},{"title":"Create sender pool","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/sender-pools","href":"/api-reference/all-endpoints/sender-pools/create-sender-pool"},{"title":"Get sender pool","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/sender-pools/{id}","href":"/api-reference/all-endpoints/sender-pools/get-sender-pool"},{"title":"Delete sender pool","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/sender-pools/{id}","href":"/api-reference/all-endpoints/sender-pools/delete-sender-pool"},{"title":"Update sender pool","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/sender-pools/{id}","href":"/api-reference/all-endpoints/sender-pools/update-sender-pool"},{"title":"Preview sender pool selection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/sender-pools/{id}/preview","href":"/api-reference/all-endpoints/sender-pools/preview-sender-pool-selection"},{"title":"Get sender pool health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/sender-pools/{id}/health","href":"/api-reference/all-endpoints/sender-pools/get-sender-pool-health"},{"title":"Explain pool members against the verified inbound inventory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/sender-pools/{id}/inbound-inventory","href":"/api-reference/all-endpoints/sender-pools/explain-pool-members-against-the-verified-inbound-inventory"}]},{"group":"Opt-Out Lists","pages":[{"title":"List opt-out lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/opt-out-lists","href":"/api-reference/all-endpoints/opt-out-lists/list-opt-out-lists"},{"title":"Create opt-out list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/messaging/opt-out-lists","href":"/api-reference/all-endpoints/opt-out-lists/create-opt-out-list"},{"title":"Get opt-out list","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/messaging/opt-out-lists/{id}","href":"/api-reference/all-endpoints/opt-out-lists/get-opt-out-list"},{"title":"Delete opt-out list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/messaging/opt-out-lists/{id}","href":"/api-reference/all-endpoints/opt-out-lists/delete-opt-out-list"},{"title":"Update opt-out list","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/messaging/opt-out-lists/{id}","href":"/api-reference/all-endpoints/opt-out-lists/update-opt-out-list"}]},{"group":"Insights","pages":[{"title":"Get AI-spend headline stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/overview","href":"/api-reference/all-endpoints/insights/get-ai-spend-headline-stats"},{"title":"Get grouped AI-spend summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/summary","href":"/api-reference/all-endpoints/insights/get-grouped-ai-spend-summary"},{"title":"Get AI-spend trend buckets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/timeseries","href":"/api-reference/all-endpoints/insights/get-ai-spend-trend-buckets"},{"title":"Get top-spending conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/top-conversations","href":"/api-reference/all-endpoints/insights/get-top-spending-conversations"},{"title":"Get AI spend by feature","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/by-feature","href":"/api-reference/all-endpoints/insights/get-ai-spend-by-feature"},{"title":"Get AI budget configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/budget","href":"/api-reference/all-endpoints/insights/get-ai-budget-configuration"},{"title":"Update AI budget configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/llm-spend/budget","href":"/api-reference/all-endpoints/insights/update-ai-budget-configuration"},{"title":"Get AI spend by model","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/by-model","href":"/api-reference/all-endpoints/insights/get-ai-spend-by-model"},{"title":"Get per-model spend caps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/llm-spend/model-caps","href":"/api-reference/all-endpoints/insights/get-per-model-spend-caps"},{"title":"Update per-model spend caps","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/llm-spend/model-caps","href":"/api-reference/all-endpoints/insights/update-per-model-spend-caps"},{"title":"Get per-agent ROI summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-roi","href":"/api-reference/all-endpoints/insights/get-per-agent-roi-summary"},{"title":"Get the daily ROI trend","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-roi/timeseries","href":"/api-reference/all-endpoints/insights/get-the-daily-roi-trend"},{"title":"Get ROI attribution configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-roi/config","href":"/api-reference/all-endpoints/insights/get-roi-attribution-configuration"},{"title":"Update ROI attribution configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/agent-roi/config","href":"/api-reference/all-endpoints/insights/update-roi-attribution-configuration"},{"title":"Get blended cost-to-serve summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/conversation-pnl","href":"/api-reference/all-endpoints/insights/get-blended-cost-to-serve-summary"},{"title":"Get P\u0026L labour-rate configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/conversation-pnl/config","href":"/api-reference/all-endpoints/insights/get-p\u0026l-labour-rate-configuration"},{"title":"Update P\u0026L labour-rate configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/conversation-pnl/config","href":"/api-reference/all-endpoints/insights/update-p\u0026l-labour-rate-configuration"},{"title":"Get cross-channel unit economics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/cost-economics","href":"/api-reference/all-endpoints/insights/get-cross-channel-unit-economics"},{"title":"Get cost-economics rate configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/cost-economics/config","href":"/api-reference/all-endpoints/insights/get-cost-economics-rate-configuration"},{"title":"Update cost-economics rate configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/cost-economics/config","href":"/api-reference/all-endpoints/insights/update-cost-economics-rate-configuration"},{"title":"Get AI-agent containment summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/containment","href":"/api-reference/all-endpoints/insights/get-ai-agent-containment-summary"},{"title":"Get the daily containment trend","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/containment/timeseries","href":"/api-reference/all-endpoints/insights/get-the-daily-containment-trend"},{"title":"Get language-segmented quality summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/language-quality","href":"/api-reference/all-endpoints/insights/get-language-segmented-quality-summary"},{"title":"Compare AI agents side by side","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-comparison","href":"/api-reference/all-endpoints/insights/compare-ai-agents-side-by-side"},{"title":"Benchmark agents against the org population","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-benchmarks","href":"/api-reference/all-endpoints/insights/benchmark-agents-against-the-org-population"},{"title":"Agent quality segmented by detected language","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/agent-quality/by-language","href":"/api-reference/all-endpoints/insights/agent-quality-segmented-by-detected-language"},{"title":"List ranked automation opportunities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/automation-opportunities","href":"/api-reference/all-endpoints/insights/list-ranked-automation-opportunities"},{"title":"Get inbound-call marketing attribution","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/call-attribution","href":"/api-reference/all-endpoints/insights/get-inbound-call-marketing-attribution"},{"title":"Get automation ROI assumptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/automation-opportunities/config","href":"/api-reference/all-endpoints/insights/get-automation-roi-assumptions"},{"title":"Update automation ROI assumptions","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/automation-opportunities/config","href":"/api-reference/all-endpoints/insights/update-automation-roi-assumptions"},{"title":"Get KB auto-draft configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/kb-auto-draft/config","href":"/api-reference/all-endpoints/insights/get-kb-auto-draft-configuration"},{"title":"Update KB auto-draft configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/kb-auto-draft/config","href":"/api-reference/all-endpoints/insights/update-kb-auto-draft-configuration"},{"title":"Run the KB auto-draft miner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/insights/kb-auto-draft/run","href":"/api-reference/all-endpoints/insights/run-the-kb-auto-draft-miner"},{"title":"Get no-match miner configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/no-match-questions/config","href":"/api-reference/all-endpoints/insights/get-no-match-miner-configuration"},{"title":"Update no-match miner configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/no-match-questions/config","href":"/api-reference/all-endpoints/insights/update-no-match-miner-configuration"},{"title":"Run the no-match query miner","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/insights/no-match-questions/run","href":"/api-reference/all-endpoints/insights/run-the-no-match-query-miner"},{"title":"Get sales conversation intelligence summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/sales-conversation-intelligence","href":"/api-reference/all-endpoints/insights/get-sales-conversation-intelligence-summary"},{"title":"Get sales intelligence configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/sales-conversation-intelligence/config","href":"/api-reference/all-endpoints/insights/get-sales-intelligence-configuration"},{"title":"Update sales intelligence configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/insights/sales-conversation-intelligence/config","href":"/api-reference/all-endpoints/insights/update-sales-intelligence-configuration"},{"title":"Aggregate anomaly ledger by scope","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/anomaly-insights/by-scope","href":"/api-reference/all-endpoints/insights/aggregate-anomaly-ledger-by-scope"},{"title":"List anomaly ledger items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/anomaly-insights/history","href":"/api-reference/all-endpoints/insights/list-anomaly-ledger-items"},{"title":"Anomaly counts over time","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/insights/anomaly-insights/timeseries","href":"/api-reference/all-endpoints/insights/anomaly-counts-over-time"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications","href":"/api-reference/all-endpoints/notifications/list-notifications"},{"title":"List global","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications/global","href":"/api-reference/all-endpoints/notifications/list-global"},{"title":"List unread-count","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications/unread-count","href":"/api-reference/all-endpoints/notifications/list-unread-count"},{"title":"Update read","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/notifications/{id}/read","href":"/api-reference/all-endpoints/notifications/update-read"},{"title":"Read-all notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/notifications/read-all","href":"/api-reference/all-endpoints/notifications/read-all-notifications"},{"title":"Delete notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/notifications/{id}","href":"/api-reference/all-endpoints/notifications/delete-notifications"},{"title":"Sse-token notifications","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/notifications/sse-token","href":"/api-reference/all-endpoints/notifications/sse-token-notifications"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications/stream","href":"/api-reference/all-endpoints/notifications/list-stream"},{"title":"List settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications/digest/settings","href":"/api-reference/all-endpoints/notifications/list-settings"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/notifications/digest/settings","href":"/api-reference/all-endpoints/notifications/update-settings"},{"title":"List recipients","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/notifications/digest/recipients","href":"/api-reference/all-endpoints/notifications/list-recipients"},{"title":"Patch recipients","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/notifications/digest/recipients/{user_id}","href":"/api-reference/all-endpoints/notifications/patch-recipients"},{"title":"Preview digest","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/notifications/digest/preview","href":"/api-reference/all-endpoints/notifications/preview-digest"}]},{"group":"Oncall","pages":[{"title":"Resolve oncall","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/oncall/resolve","href":"/api-reference/all-endpoints/oncall/resolve-oncall"},{"title":"Plan escalation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/oncall/escalation/plan","href":"/api-reference/all-endpoints/oncall/plan-escalation"},{"title":"Tick incident","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/oncall/incident/tick","href":"/api-reference/all-endpoints/oncall/tick-incident"},{"title":"Transition incident","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/oncall/incident/transition","href":"/api-reference/all-endpoints/oncall/transition-incident"}]},{"group":"Me","pages":[{"title":"List favorites","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/favorites","href":"/api-reference/all-endpoints/me/list-favorites"},{"title":"Create a favorite","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/me/favorites","href":"/api-reference/all-endpoints/me/create-a-favorite"},{"title":"Delete a favorite","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/me/favorites/{id}","href":"/api-reference/all-endpoints/me/delete-a-favorite"},{"title":"Update a favorite","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/me/favorites/{id}","href":"/api-reference/all-endpoints/me/update-a-favorite"},{"title":"List ring-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/ring-rules","href":"/api-reference/all-endpoints/me/list-ring-rules"},{"title":"Update ring-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/me/ring-rules","href":"/api-reference/all-endpoints/me/update-ring-rules"},{"title":"List generated-reports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/generated-reports","href":"/api-reference/all-endpoints/me/list-generated-reports"},{"title":"Update generated-reports","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/me/generated-reports","href":"/api-reference/all-endpoints/me/update-generated-reports"},{"title":"List recommendations-draft","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/recommendations-draft","href":"/api-reference/all-endpoints/me/list-recommendations-draft"},{"title":"Update recommendations-draft","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/me/recommendations-draft","href":"/api-reference/all-endpoints/me/update-recommendations-draft"},{"title":"Get predictive-activation schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/predictive-activation-schedule","href":"/api-reference/all-endpoints/me/get-predictive-activation-schedule"},{"title":"Replace predictive-activation schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/me/predictive-activation-schedule","href":"/api-reference/all-endpoints/me/replace-predictive-activation-schedule"},{"title":"List campaign-drafts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me/campaign-drafts","href":"/api-reference/all-endpoints/me/list-campaign-drafts"},{"title":"Update campaign-drafts","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/me/campaign-drafts","href":"/api-reference/all-endpoints/me/update-campaign-drafts"}]},{"group":"Account","pages":[{"title":"Get the authenticated user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/me","href":"/api-reference/all-endpoints/account/get-the-authenticated-user"},{"title":"Update per-user preferences","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/me","href":"/api-reference/all-endpoints/account/update-per-user-preferences"}]},{"group":"Users","pages":[{"title":"Set your own presence status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/users/me/presence","href":"/api-reference/all-endpoints/users/set-your-own-presence-status"},{"title":"Set your recurring DND schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/users/me/presence/schedule","href":"/api-reference/all-endpoints/users/set-your-recurring-dnd-schedule"}]},{"group":"Search Analytics","pages":[{"title":"Top search queries by volume","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/search-analytics/top-queries","href":"/api-reference/all-endpoints/search-analytics/top-search-queries-by-volume"},{"title":"Queries that returned no results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/search-analytics/zero-result","href":"/api-reference/all-endpoints/search-analytics/queries-that-returned-no-results"},{"title":"Search click-through rate per query","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/search-analytics/click-through","href":"/api-reference/all-endpoints/search-analytics/search-click-through-rate-per-query"},{"title":"Search queries that failed to parse","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/search-analytics/parse-failures","href":"/api-reference/all-endpoints/search-analytics/search-queries-that-failed-to-parse"},{"title":"Record a click on a search result","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/search-analytics/click","href":"/api-reference/all-endpoints/search-analytics/record-a-click-on-a-search-result"}]},{"group":"Search","pages":[{"title":"Global search","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/search/global","href":"/api-reference/all-endpoints/search/global-search"}]},{"group":"UsageRecords","pages":[{"title":"List usage-records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage-records","href":"/api-reference/all-endpoints/usagerecords/list-usage-records"},{"title":"List export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage-records/export.csv","href":"/api-reference/all-endpoints/usagerecords/list-exportcsv"}]},{"group":"Usage","pages":[{"title":"List ai","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/ai","href":"/api-reference/all-endpoints/usage/list-ai"},{"title":"Rollup meters","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/usage/meters/rollup","href":"/api-reference/all-endpoints/usage/rollup-meters"},{"title":"Credit-note meters","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/usage/meters/credit-note","href":"/api-reference/all-endpoints/usage/credit-note-meters"},{"title":"List alert-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/alert-rules","href":"/api-reference/all-endpoints/usage/list-alert-rules"},{"title":"Alert-rules usage","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/usage/alert-rules","href":"/api-reference/all-endpoints/usage/alert-rules-usage"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/alert-rules/events","href":"/api-reference/all-endpoints/usage/list-events"},{"title":"Delete alert-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/usage/alert-rules/{id}","href":"/api-reference/all-endpoints/usage/delete-alert-rules"},{"title":"Patch alert-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/usage/alert-rules/{id}","href":"/api-reference/all-endpoints/usage/patch-alert-rules"},{"title":"Evaluate alert-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/usage/alert-rules/evaluate","href":"/api-reference/all-endpoints/usage/evaluate-alert-rules"},{"title":"List inbound-cost","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/inbound-cost","href":"/api-reference/all-endpoints/usage/list-inbound-cost"},{"title":"List cdr","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/cdr","href":"/api-reference/all-endpoints/usage/list-cdr"},{"title":"List export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/usage/cdr/export.csv","href":"/api-reference/all-endpoints/usage/list-exportcsv"}]},{"group":"Wfm","pages":[{"title":"Recompute forecasts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/forecasts/recompute","href":"/api-reference/all-endpoints/wfm/recompute-forecasts"},{"title":"What-if forecasts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/forecasts/what-if","href":"/api-reference/all-endpoints/wfm/what-if-forecasts"},{"title":"List forecasts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/forecasts","href":"/api-reference/all-endpoints/wfm/list-forecasts"},{"title":"List accuracy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/forecasts/accuracy","href":"/api-reference/all-endpoints/wfm/list-accuracy"},{"title":"Optimize staffing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/staffing/optimize","href":"/api-reference/all-endpoints/wfm/optimize-staffing"},{"title":"Plan capacity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/capacity/plan","href":"/api-reference/all-endpoints/wfm/plan-capacity"},{"title":"Recommend rebalancing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/rebalancing/recommend","href":"/api-reference/all-endpoints/wfm/recommend-rebalancing"},{"title":"List shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/shifts","href":"/api-reference/all-endpoints/wfm/list-shifts"},{"title":"Shifts wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/shifts","href":"/api-reference/all-endpoints/wfm/shifts-wfm"},{"title":"Get shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/shifts/{id}","href":"/api-reference/all-endpoints/wfm/get-shifts"},{"title":"Delete shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/wfm/shifts/{id}","href":"/api-reference/all-endpoints/wfm/delete-shifts"},{"title":"Patch shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/wfm/shifts/{id}","href":"/api-reference/all-endpoints/wfm/patch-shifts"},{"title":"List activities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/shifts/{shiftId}/activities","href":"/api-reference/all-endpoints/wfm/list-activities"},{"title":"Create activities","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/shifts/{shiftId}/activities","href":"/api-reference/all-endpoints/wfm/create-activities"},{"title":"Delete activities","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/wfm/shifts/{shiftId}/activities/{id}","href":"/api-reference/all-endpoints/wfm/delete-activities"},{"title":"List conformance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence/conformance","href":"/api-reference/all-endpoints/wfm/list-conformance"},{"title":"List assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/assignments","href":"/api-reference/all-endpoints/wfm/list-assignments"},{"title":"Assignments wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/assignments","href":"/api-reference/all-endpoints/wfm/assignments-wfm"},{"title":"Bulk assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/assignments/bulk","href":"/api-reference/all-endpoints/wfm/bulk-assignments"},{"title":"Get assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/assignments/{id}","href":"/api-reference/all-endpoints/wfm/get-assignments"},{"title":"Delete assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/wfm/assignments/{id}","href":"/api-reference/all-endpoints/wfm/delete-assignments"},{"title":"Patch assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/wfm/assignments/{id}","href":"/api-reference/all-endpoints/wfm/patch-assignments"},{"title":"List requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/requests","href":"/api-reference/all-endpoints/wfm/list-requests"},{"title":"Requests wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/requests","href":"/api-reference/all-endpoints/wfm/requests-wfm"},{"title":"Get requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/requests/{id}","href":"/api-reference/all-endpoints/wfm/get-requests"},{"title":"Create accept-swap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/requests/{id}/accept-swap","href":"/api-reference/all-endpoints/wfm/create-accept-swap"},{"title":"Create approve","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/requests/{id}/approve","href":"/api-reference/all-endpoints/wfm/create-approve"},{"title":"Create deny","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/requests/{id}/deny","href":"/api-reference/all-endpoints/wfm/create-deny"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts/{id}/cancel","href":"/api-reference/all-endpoints/wfm/create-cancel"},{"title":"List leave-policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/leave-policies","href":"/api-reference/all-endpoints/wfm/list-leave-policies"},{"title":"Leave-policies wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/leave-policies","href":"/api-reference/all-endpoints/wfm/leave-policies-wfm"},{"title":"List leave-balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/leave-balances","href":"/api-reference/all-endpoints/wfm/list-leave-balances"},{"title":"Get leave-balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/leave-balances/{agentId}","href":"/api-reference/all-endpoints/wfm/get-leave-balances"},{"title":"Create adjust","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/leave-balances/{agentId}/adjust","href":"/api-reference/all-endpoints/wfm/create-adjust"},{"title":"List adherence","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence","href":"/api-reference/all-endpoints/wfm/list-adherence"},{"title":"List team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence/team","href":"/api-reference/all-endpoints/wfm/list-team"},{"title":"List intraday","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence/intraday","href":"/api-reference/all-endpoints/wfm/list-intraday"},{"title":"List adherence-exceptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence-exceptions","href":"/api-reference/all-endpoints/wfm/list-adherence-exceptions"},{"title":"Adherence-exceptions wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/adherence-exceptions","href":"/api-reference/all-endpoints/wfm/adherence-exceptions-wfm"},{"title":"List trends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/adherence-exceptions/trends","href":"/api-reference/all-endpoints/wfm/list-trends"},{"title":"Create approve","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/adherence-exceptions/{id}/approve","href":"/api-reference/all-endpoints/wfm/create-approve-1"},{"title":"Create deny","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/adherence-exceptions/{id}/deny","href":"/api-reference/all-endpoints/wfm/create-deny-1"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/adherence-exceptions/{id}/cancel","href":"/api-reference/all-endpoints/wfm/create-cancel-1"},{"title":"List stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/rta/stream","href":"/api-reference/all-endpoints/wfm/list-stream"},{"title":"List breaches","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/rta/breaches","href":"/api-reference/all-endpoints/wfm/list-breaches"},{"title":"List staffing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/intraday/staffing","href":"/api-reference/all-endpoints/wfm/list-staffing"},{"title":"Recompute shrinkage","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/shrinkage/recompute","href":"/api-reference/all-endpoints/wfm/recompute-shrinkage"},{"title":"List shrinkage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/shrinkage","href":"/api-reference/all-endpoints/wfm/list-shrinkage"},{"title":"List agent-wellness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/agent-wellness","href":"/api-reference/all-endpoints/wfm/list-agent-wellness"},{"title":"List agent-flight-risk","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/agent-flight-risk","href":"/api-reference/all-endpoints/wfm/list-agent-flight-risk"},{"title":"List timesheets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/timesheets","href":"/api-reference/all-endpoints/wfm/list-timesheets"},{"title":"List payroll-export.csv","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/timesheets/payroll-export.csv","href":"/api-reference/all-endpoints/wfm/list-payroll-exportcsv"}]},{"group":"WFM","pages":[{"title":"Apply rebalancing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/rebalancing/apply","href":"/api-reference/all-endpoints/wfm/apply-rebalancing"},{"title":"Generate schedules","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/schedules/generate","href":"/api-reference/all-endpoints/wfm/generate-schedules"},{"title":"Commit generate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/schedules/generate/commit","href":"/api-reference/all-endpoints/wfm/commit-generate"},{"title":"List open-shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/open-shifts","href":"/api-reference/all-endpoints/wfm/list-open-shifts"},{"title":"Open-shifts wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts","href":"/api-reference/all-endpoints/wfm/open-shifts-wfm"},{"title":"Get open-shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/open-shifts/{id}","href":"/api-reference/all-endpoints/wfm/get-open-shifts"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts/{id}/cancel","href":"/api-reference/all-endpoints/wfm/create-cancel"},{"title":"List bids","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/open-shifts/{id}/bids","href":"/api-reference/all-endpoints/wfm/list-bids"},{"title":"Create bids","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts/{id}/bids","href":"/api-reference/all-endpoints/wfm/create-bids"},{"title":"Create withdraw","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts/{id}/bids/{bidId}/withdraw","href":"/api-reference/all-endpoints/wfm/create-withdraw"},{"title":"Create award","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/open-shifts/{id}/award","href":"/api-reference/all-endpoints/wfm/create-award"},{"title":"List overtime-offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/overtime-offers","href":"/api-reference/all-endpoints/wfm/list-overtime-offers"},{"title":"Overtime-offers wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/overtime-offers","href":"/api-reference/all-endpoints/wfm/overtime-offers-wfm"},{"title":"Get overtime-offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/overtime-offers/{id}","href":"/api-reference/all-endpoints/wfm/get-overtime-offers"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/adherence-exceptions/{id}/cancel","href":"/api-reference/all-endpoints/wfm/create-cancel-1"},{"title":"List claims","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/overtime-offers/{id}/claims","href":"/api-reference/all-endpoints/wfm/list-claims"},{"title":"Create claims","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/overtime-offers/{id}/claims","href":"/api-reference/all-endpoints/wfm/create-claims"},{"title":"Create withdraw","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/overtime-offers/{id}/claims/{claimId}/withdraw","href":"/api-reference/all-endpoints/wfm/create-withdraw-1"},{"title":"Create award","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/overtime-offers/{id}/award","href":"/api-reference/all-endpoints/wfm/create-award-1"},{"title":"List vto-offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/vto-offers","href":"/api-reference/all-endpoints/wfm/list-vto-offers"},{"title":"Vto-offers wfm","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/vto-offers","href":"/api-reference/all-endpoints/wfm/vto-offers-wfm"},{"title":"Get vto-offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/vto-offers/{id}","href":"/api-reference/all-endpoints/wfm/get-vto-offers"},{"title":"Create cancel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/vto-offers/{id}/cancel","href":"/api-reference/all-endpoints/wfm/create-cancel-2"},{"title":"List claims","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/vto-offers/{id}/claims","href":"/api-reference/all-endpoints/wfm/list-claims-1"},{"title":"Create claims","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/vto-offers/{id}/claims","href":"/api-reference/all-endpoints/wfm/create-claims-1"},{"title":"Create withdraw","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/vto-offers/{id}/claims/{claimId}/withdraw","href":"/api-reference/all-endpoints/wfm/create-withdraw-2"},{"title":"Create award","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/wfm/vto-offers/{id}/award","href":"/api-reference/all-endpoints/wfm/create-award-2"},{"title":"Upsert one agent-skill row (set or re-rate proficiency)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/wfm/agent-skills/{agentId}/{skill}","href":"/api-reference/all-endpoints/wfm/upsert-one-agent-skill-row-set-or-re-rate-proficiency"},{"title":"Remove one agent-skill row","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/wfm/agent-skills/{agentId}/{skill}","href":"/api-reference/all-endpoints/wfm/remove-one-agent-skill-row"},{"title":"List the per-agent skill registry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/agent-skills","href":"/api-reference/all-endpoints/wfm/list-the-per-agent-skill-registry"},{"title":"Get the WFM overview summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/wfm/summary","href":"/api-reference/all-endpoints/wfm/get-the-wfm-overview-summary"}]},{"group":"Practice Studio","pages":[{"title":"List built-in practice scenarios","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/practice-studio/scenarios","href":"/api-reference/all-endpoints/practice-studio/list-built-in-practice-scenarios"},{"title":"Generate the simulated customer's next turn","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/practice-studio/turn","href":"/api-reference/all-endpoints/practice-studio/generate-the-simulated-customers-next-turn"},{"title":"Grade a finished practice session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/practice-studio/score","href":"/api-reference/all-endpoints/practice-studio/grade-a-finished-practice-session"}]},{"group":"Dialer","pages":[{"title":"List dialer campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns","href":"/api-reference/all-endpoints/dialer/list-dialer-campaigns"},{"title":"Create a dialer campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns","href":"/api-reference/all-endpoints/dialer/create-a-dialer-campaign"},{"title":"Dialer campaign stats (tenant-wide KPI strip)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/stats","href":"/api-reference/all-endpoints/dialer/dialer-campaign-stats-tenant-wide-kpi-strip"},{"title":"Get a dialer campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}","href":"/api-reference/all-endpoints/dialer/get-a-dialer-campaign"},{"title":"Soft-delete a dialer campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/dialer/campaigns/{id}","href":"/api-reference/all-endpoints/dialer/soft-delete-a-dialer-campaign"},{"title":"Update a dialer campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/dialer/campaigns/{id}","href":"/api-reference/all-endpoints/dialer/update-a-dialer-campaign"},{"title":"Create clone","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns/{id}/clone","href":"/api-reference/all-endpoints/dialer/create-clone"},{"title":"List lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/lists","href":"/api-reference/all-endpoints/dialer/list-lists"},{"title":"Upload a contact list to a dialer campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns/{id}/lists","href":"/api-reference/all-endpoints/dialer/upload-a-contact-list-to-a-dialer-campaign"},{"title":"Soft-delete a dialer contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/dialer/campaigns/{id}/lists/{listId}","href":"/api-reference/all-endpoints/dialer/soft-delete-a-dialer-contact-list"},{"title":"Create recycle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns/{id}/lists/{listId}/recycle","href":"/api-reference/all-endpoints/dialer/create-recycle"},{"title":"List penetration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/lists/{listId}/penetration","href":"/api-reference/all-endpoints/dialer/list-penetration"},{"title":"Dialer campaign wallboard stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/stats","href":"/api-reference/all-endpoints/dialer/dialer-campaign-wallboard-stats"},{"title":"Dialer local-presence caller-ID coverage + analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/caller-id-coverage","href":"/api-reference/all-endpoints/dialer/dialer-local-presence-caller-id-coverage-+-analytics"},{"title":"Dialer campaign post-call AI sentiment + outcome rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/sentiment","href":"/api-reference/all-endpoints/dialer/dialer-campaign-post-call-ai-sentiment-+-outcome-rollup"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/voice-agents/{agentId}/campaigns","href":"/api-reference/all-endpoints/dialer/list-campaigns"},{"title":"Submit a dialer call disposition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns/{id}/dispositions","href":"/api-reference/all-endpoints/dialer/submit-a-dialer-call-disposition"},{"title":"Claim the next preview-mode contact for an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/next-call","href":"/api-reference/all-endpoints/dialer/claim-the-next-preview-mode-contact-for-an-agent"},{"title":"Originate a preview-mode dial for a claimed contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/dial","href":"/api-reference/all-endpoints/dialer/originate-a-preview-mode-dial-for-a-claimed-contact"},{"title":"Manual-dial dialer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/manual-dial","href":"/api-reference/all-endpoints/dialer/manual-dial-dialer"},{"title":"Batch-dispatch outbound calls to a voice agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/dialer/campaigns/{id}/batch-dispatch","href":"/api-reference/all-endpoints/dialer/batch-dispatch-outbound-calls-to-a-voice-agent"},{"title":"Get post-call AI sentiment + outcome scoring for a dialer attempt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/dialer/campaigns/{id}/attempts/{attemptId}/outcome-scoring","href":"/api-reference/all-endpoints/dialer/get-post-call-ai-sentiment-+-outcome-scoring-for-a-dialer-attempt"}]},{"group":"CustomFields","pages":[{"title":"Propose a custom field definition from a description","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/custom-fields/suggest","href":"/api-reference/all-endpoints/customfields/propose-a-custom-field-definition-from-a-description"},{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/custom-fields","href":"/api-reference/all-endpoints/customfields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/custom-fields","href":"/api-reference/all-endpoints/customfields/create-a-custom-field-definition"},{"title":"Get a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/custom-fields/{id}","href":"/api-reference/all-endpoints/customfields/get-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/custom-fields/{id}","href":"/api-reference/all-endpoints/customfields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/custom-fields/{id}","href":"/api-reference/all-endpoints/customfields/update-a-custom-field-definition"},{"title":"Scan dependents (segments / campaigns / flows / contacts)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/custom-fields/{id}/dependencies","href":"/api-reference/all-endpoints/customfields/scan-dependents-segments-campaigns-flows-contacts"},{"title":"Schema-explorer payload: definition + usage counts + last-10 PII-redacted sample values","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/custom-fields/{id}/explorer","href":"/api-reference/all-endpoints/customfields/schema-explorer-payload:-definition-+-usage-counts-+-last-10-pii-redacted-sample-values"},{"title":"Set a custom-field value on a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/custom-fields/values","href":"/api-reference/all-endpoints/customfields/set-a-custom-field-value-on-a-contact"},{"title":"Reorder custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/custom-fields/reorder","href":"/api-reference/all-endpoints/customfields/reorder-custom-field-definitions"}]},{"group":"FrequencyCaps","pages":[{"title":"List per-org frequency-cap rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/frequency-caps","href":"/api-reference/all-endpoints/frequencycaps/list-per-org-frequency-cap-rules"},{"title":"Create a new frequency-cap rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/frequency-caps","href":"/api-reference/all-endpoints/frequencycaps/create-a-new-frequency-cap-rule"},{"title":"Get a single frequency-cap rule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/frequency-caps/{id}","href":"/api-reference/all-endpoints/frequencycaps/get-a-single-frequency-cap-rule"},{"title":"Delete a frequency-cap rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/frequency-caps/{id}","href":"/api-reference/all-endpoints/frequencycaps/delete-a-frequency-cap-rule"},{"title":"Update a frequency-cap rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/frequency-caps/{id}","href":"/api-reference/all-endpoints/frequencycaps/update-a-frequency-cap-rule"}]},{"group":"MessageSuppression","pages":[{"title":"Get the duplicate-message suppression policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/message-suppression","href":"/api-reference/all-endpoints/messagesuppression/get-the-duplicate-message-suppression-policy"},{"title":"Create or update the duplicate-message suppression policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/message-suppression","href":"/api-reference/all-endpoints/messagesuppression/create-or-update-the-duplicate-message-suppression-policy"},{"title":"Delete the duplicate-message suppression policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/message-suppression","href":"/api-reference/all-endpoints/messagesuppression/delete-the-duplicate-message-suppression-policy"}]},{"group":"SIP Credentials","pages":[{"title":"List SIP credentials","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sip-credentials","href":"/api-reference/all-endpoints/sip-credentials/list-sip-credentials"},{"title":"Create a new SIP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sip-credentials","href":"/api-reference/all-endpoints/sip-credentials/create-a-new-sip-credential"},{"title":"Get a SIP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/sip-credentials/{id}","href":"/api-reference/all-endpoints/sip-credentials/get-a-sip-credential"},{"title":"Delete a SIP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/sip-credentials/{id}","href":"/api-reference/all-endpoints/sip-credentials/delete-a-sip-credential"},{"title":"Update a SIP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/sip-credentials/{id}","href":"/api-reference/all-endpoints/sip-credentials/update-a-sip-credential"},{"title":"Rotate a SIP credential password","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sip-credentials/{id}/rotate","href":"/api-reference/all-endpoints/sip-credentials/rotate-a-sip-credential-password"},{"title":"Force unregister a SIP credential","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/sip-credentials/{id}/unregister","href":"/api-reference/all-endpoints/sip-credentials/force-unregister-a-sip-credential"}]},{"group":"Jambonz","pages":[{"title":"Authorize a SIP REGISTER","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/auth/register","href":"/api-reference/all-endpoints/jambonz/authorize-a-sip-register"},{"title":"Authorize a customer-trunk INVITE or REGISTER","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/customer-trunk-auth","href":"/api-reference/all-endpoints/jambonz/authorize-a-customer-trunk-invite-or-register"},{"title":"Resolve an inbound call's route","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/lookup","href":"/api-reference/all-endpoints/jambonz/resolve-an-inbound-calls-route"},{"title":"Track a call's lifecycle status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/call-status","href":"/api-reference/all-endpoints/jambonz/track-a-calls-lifecycle-status"},{"title":"Authorize a registered UA's outbound INVITE","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/dial-confirm","href":"/api-reference/all-endpoints/jambonz/authorize-a-registered-uas-outbound-invite"},{"title":"Device-call jambonz","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/device-call","href":"/api-reference/all-endpoints/jambonz/device-call-jambonz"},{"title":"Execute a dialed star code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/feature-code","href":"/api-reference/all-endpoints/jambonz/execute-a-dialed-star-code"},{"title":"Verify a voicemail PIN for TUI retrieval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/voicemail-pin","href":"/api-reference/all-endpoints/jambonz/verify-a-voicemail-pin-for-tui-retrieval"},{"title":"Store a finished voicemail recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/voicemail-store","href":"/api-reference/all-endpoints/jambonz/store-a-finished-voicemail-recording"},{"title":"Track a `dial` verb completion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/dial-status","href":"/api-reference/all-endpoints/jambonz/track-a-`dial`-verb-completion"},{"title":"Poll a queued caller's wait state","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/queue-wait","href":"/api-reference/all-endpoints/jambonz/poll-a-queued-callers-wait-state"},{"title":"DTMF opt-out from a queue into voicemail","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/mid-queue-voicemail","href":"/api-reference/all-endpoints/jambonz/dtmf-opt-out-from-a-queue-into-voicemail"},{"title":"Resolve a queue's terminal outcome","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/queue-action","href":"/api-reference/all-endpoints/jambonz/resolve-a-queues-terminal-outcome"},{"title":"Play wait music in a conference","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/conference-wait-music","href":"/api-reference/all-endpoints/jambonz/play-wait-music-in-a-conference"},{"title":"Answer a resolved virtual-hold callback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/callback-answer","href":"/api-reference/all-endpoints/jambonz/answer-a-resolved-virtual-hold-callback"},{"title":"Advance a sequential ring-group to the next target","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/lookup-next","href":"/api-reference/all-endpoints/jambonz/advance-a-sequential-ring-group-to-the-next-target"},{"title":"Advance an IVR flow to the next step","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/ivr-step","href":"/api-reference/all-endpoints/jambonz/advance-an-ivr-flow-to-the-next-step"},{"title":"Finalize an IVR voicemail recording","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/ivr-record-finalize","href":"/api-reference/all-endpoints/jambonz/finalize-an-ivr-voicemail-recording"},{"title":"Bridge the parked carrier leg into an Orbit Media room","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/bridge-to-lk","href":"/api-reference/all-endpoints/jambonz/bridge-the-parked-carrier-leg-into-an-orbit-media-room"},{"title":"Announce a queue overflow to the caller","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/queue-overflow","href":"/api-reference/all-endpoints/jambonz/announce-a-queue-overflow-to-the-caller"},{"title":"Resolve a softphone park timeout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/pause-elapsed","href":"/api-reference/all-endpoints/jambonz/resolve-a-softphone-park-timeout"},{"title":"Join a supervisor to a live call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/supervisor-bridge","href":"/api-reference/all-endpoints/jambonz/join-a-supervisor-to-a-live-call"},{"title":"Ingest Orbit Media RTCP-XR call-quality metrics","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/jambonz/quality-ingest","href":"/api-reference/all-endpoints/jambonz/ingest-orbit-media-rtcp-xr-call-quality-metrics"}]},{"group":"Channels","pages":[{"title":"Inbound WhatsApp Flows completion webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/channels/whatsapp/flows/endpoint","href":"/api-reference/all-endpoints/channels/inbound-whatsapp-flows-completion-webhook"},{"title":"List WhatsApp Flows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/channels/whatsapp/flows","href":"/api-reference/all-endpoints/channels/list-whatsapp-flows"},{"title":"Inbound Apple Messages for Business webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/channels/amb/webhook","href":"/api-reference/all-endpoints/channels/inbound-apple-messages-for-business-webhook"},{"title":"List Apple Messages for Business agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/channels/amb/agents","href":"/api-reference/all-endpoints/channels/list-apple-messages-for-business-agents"},{"title":"Register an Apple Messages for Business agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/channels/amb/agents","href":"/api-reference/all-endpoints/channels/register-an-apple-messages-for-business-agent"},{"title":"Delete an Apple Messages for Business agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/channels/amb/agents/{id}","href":"/api-reference/all-endpoints/channels/delete-an-apple-messages-for-business-agent"},{"title":"Update an Apple Messages for Business agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/channels/amb/agents/{id}","href":"/api-reference/all-endpoints/channels/update-an-apple-messages-for-business-agent"}]},{"group":"Inbox","pages":[{"title":"Heartbeat — register the caller as viewing this conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/viewing","href":"/api-reference/all-endpoints/inbox/heartbeat-—-register-the-caller-as-viewing-this-conversation"},{"title":"Unregister the caller as a viewer (tab close / route away)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/{conversationId}/viewing","href":"/api-reference/all-endpoints/inbox/unregister-the-caller-as-a-viewer-tab-close-route-away"},{"title":"List user ids currently viewing this conversation (legacy)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/{conversationId}/viewers","href":"/api-reference/all-endpoints/inbox/list-user-ids-currently-viewing-this-conversation-legacy"},{"title":"Snapshot the {viewers, typing} state for one conversation (audit #PRESENCE-1)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{conversationId}/presence","href":"/api-reference/all-endpoints/inbox/snapshot-the--state-for-one-conversation-audit-#presence-1"},{"title":"Flip the caller's typing state on or off","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/typing","href":"/api-reference/all-endpoints/inbox/flip-the-callers-typing-state-on-or-off"},{"title":"List team-only internal notes (newest first)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/{conversationId}/internal-notes","href":"/api-reference/all-endpoints/inbox/list-team-only-internal-notes-newest-first"},{"title":"Post a team-only internal note on a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/internal-notes","href":"/api-reference/all-endpoints/inbox/post-a-team-only-internal-note-on-a-conversation"},{"title":"Soft-delete an internal note (author or admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/{conversationId}/internal-notes/{noteId}","href":"/api-reference/all-endpoints/inbox/soft-delete-an-internal-note-author-or-adminowner"},{"title":"Edit a team-only internal note (author or admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/{conversationId}/internal-notes/{noteId}","href":"/api-reference/all-endpoints/inbox/edit-a-team-only-internal-note-author-or-adminowner"},{"title":"List the operators following a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/{conversationId}/followers","href":"/api-reference/all-endpoints/inbox/list-the-operators-following-a-conversation"},{"title":"Subscribe an operator to a conversation's lifecycle updates","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/followers","href":"/api-reference/all-endpoints/inbox/subscribe-an-operator-to-a-conversations-lifecycle-updates"},{"title":"Unsubscribe an operator from a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/{conversationId}/followers/{userId}","href":"/api-reference/all-endpoints/inbox/unsubscribe-an-operator-from-a-conversation"},{"title":"List inbox saved views (personal + team)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/views","href":"/api-reference/all-endpoints/inbox/list-inbox-saved-views-personal-+-team"},{"title":"Create a personal or team-wide saved view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/views","href":"/api-reference/all-endpoints/inbox/create-a-personal-or-team-wide-saved-view"},{"title":"Live counts for system smart folders + pinned saved views (audit #INBOX-VIEW-3)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/views/counts","href":"/api-reference/all-endpoints/inbox/live-counts-for-system-smart-folders-+-pinned-saved-views-audit-#inbox-view-3"},{"title":"Soft-delete a saved view (sets deleted_at, keeps the row)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/views/{id}","href":"/api-reference/all-endpoints/inbox/soft-delete-a-saved-view-sets-deleted_at-keeps-the-row"},{"title":"Rename, reorder, re-filter, pin/unpin, recolour, or rescope a saved view","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/views/{id}","href":"/api-reference/all-endpoints/inbox/rename-reorder-re-filter-pinunpin-recolour-or-rescope-a-saved-view"},{"title":"Mint a 30-day signed share-link for a saved view (preserves filter snapshot)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/views/{id}/share","href":"/api-reference/all-endpoints/inbox/mint-a-30-day-signed-share-link-for-a-saved-view-preserves-filter-snapshot"},{"title":"Resolve a saved-view share token to its filter snapshot + label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/views/share/{token}","href":"/api-reference/all-endpoints/inbox/resolve-a-saved-view-share-token-to-its-filter-snapshot-+-label"},{"title":"List the calling user's saved searches (alive only)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/searches","href":"/api-reference/all-endpoints/inbox/list-the-calling-users-saved-searches-alive-only"},{"title":"Create a saved search for the calling user","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/searches","href":"/api-reference/all-endpoints/inbox/create-a-saved-search-for-the-calling-user"},{"title":"Soft-delete a saved search (owner only)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/searches/{id}","href":"/api-reference/all-endpoints/inbox/soft-delete-a-saved-search-owner-only"},{"title":"Rename or re-filter a saved search (owner only)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/searches/{id}","href":"/api-reference/all-endpoints/inbox/rename-or-re-filter-a-saved-search-owner-only"},{"title":"List conversation routing rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/routing-rules","href":"/api-reference/all-endpoints/inbox/list-conversation-routing-rules"},{"title":"Create a new routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/routing-rules","href":"/api-reference/all-endpoints/inbox/create-a-new-routing-rule"},{"title":"Delete a routing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/routing-rules/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-routing-rule"},{"title":"Update a routing rule (name, priority, action, …)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/routing-rules/{id}","href":"/api-reference/all-endpoints/inbox/update-a-routing-rule-name-priority-action-…"},{"title":"Dry-run a rule against a sample conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/routing-rules/test","href":"/api-reference/all-endpoints/inbox/dry-run-a-rule-against-a-sample-conversation"},{"title":"Ticket-automation rule grammar (triggers/fields/actions)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-automation/catalog","href":"/api-reference/all-endpoints/inbox/ticket-automation-rule-grammar-triggersfieldsactions"},{"title":"Dry-run a ticket-automation rule against a sample ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-automation/test","href":"/api-reference/all-endpoints/inbox/dry-run-a-ticket-automation-rule-against-a-sample-ticket"},{"title":"List persisted ticket-automation rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-automation/rules","href":"/api-reference/all-endpoints/inbox/list-persisted-ticket-automation-rules"},{"title":"Create a persisted ticket-automation rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-automation/rules","href":"/api-reference/all-endpoints/inbox/create-a-persisted-ticket-automation-rule"},{"title":"Delete a persisted ticket-automation rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/ticket-automation/rules/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-persisted-ticket-automation-rule"},{"title":"Replace a persisted ticket-automation rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/ticket-automation/rules/{id}","href":"/api-reference/all-endpoints/inbox/replace-a-persisted-ticket-automation-rule"},{"title":"List digital ACD queues","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues","href":"/api-reference/all-endpoints/inbox/list-digital-acd-queues"},{"title":"Create a digital ACD queue","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/digital-queues","href":"/api-reference/all-endpoints/inbox/create-a-digital-acd-queue"},{"title":"Delete a digital ACD queue","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/digital-queues/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-digital-acd-queue"},{"title":"Update a digital ACD queue","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/digital-queues/{id}","href":"/api-reference/all-endpoints/inbox/update-a-digital-acd-queue"},{"title":"Digital ACD queue live metrics (tenant summary)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues/stats","href":"/api-reference/all-endpoints/inbox/digital-acd-queue-live-metrics-tenant-summary"},{"title":"Digital ACD queue live metrics (single queue)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues/{queueId}/stats","href":"/api-reference/all-endpoints/inbox/digital-acd-queue-live-metrics-single-queue"},{"title":"Digital ACD queue routing decision log (recent)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues/{queueId}/decisions","href":"/api-reference/all-endpoints/inbox/digital-acd-queue-routing-decision-log-recent"},{"title":"Digital ACD routing trail for one conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/routing-decisions/{conversationId}","href":"/api-reference/all-endpoints/inbox/digital-acd-routing-trail-for-one-conversation"},{"title":"Read a digital queue's SLA escalation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues/{id}/sla-escalation/policy","href":"/api-reference/all-endpoints/inbox/read-a-digital-queues-sla-escalation-policy"},{"title":"Upsert a digital queue's SLA escalation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/digital-queues/{id}/sla-escalation/policy","href":"/api-reference/all-endpoints/inbox/upsert-a-digital-queues-sla-escalation-policy"},{"title":"Clear a digital queue's SLA escalation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/digital-queues/{id}/sla-escalation/policy","href":"/api-reference/all-endpoints/inbox/clear-a-digital-queues-sla-escalation-policy"},{"title":"List a digital queue's SLA breach events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/digital-queues/{id}/sla-escalation/events","href":"/api-reference/all-endpoints/inbox/list-a-digital-queues-sla-breach-events"},{"title":"Evaluate a queue SLA snapshot and fan out breach alerts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/digital-queues/{id}/sla-escalation/scan","href":"/api-reference/all-endpoints/inbox/evaluate-a-queue-sla-snapshot-and-fan-out-breach-alerts"},{"title":"List guided agent scripts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/agent-scripts","href":"/api-reference/all-endpoints/inbox/list-guided-agent-scripts"},{"title":"Create a guided agent script","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/agent-scripts","href":"/api-reference/all-endpoints/inbox/create-a-guided-agent-script"},{"title":"Get one agent script with its step graph","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/agent-scripts/{id}","href":"/api-reference/all-endpoints/inbox/get-one-agent-script-with-its-step-graph"},{"title":"Delete a guided agent script","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/agent-scripts/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-guided-agent-script"},{"title":"Update a guided agent script","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/agent-scripts/{id}","href":"/api-reference/all-endpoints/inbox/update-a-guided-agent-script"},{"title":"List personal + shared agent macros","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/macros","href":"/api-reference/all-endpoints/inbox/list-personal-+-shared-agent-macros"},{"title":"Create a macro","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/macros","href":"/api-reference/all-endpoints/inbox/create-a-macro"},{"title":"Most-used macros for the calling user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/macros/popular","href":"/api-reference/all-endpoints/inbox/most-used-macros-for-the-calling-user"},{"title":"Delete a macro","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/macros/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-macro"},{"title":"Update a macro","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/macros/{id}","href":"/api-reference/all-endpoints/inbox/update-a-macro"},{"title":"Run a macro against a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{convId}/run-macro","href":"/api-reference/all-endpoints/inbox/run-a-macro-against-a-conversation"},{"title":"Preview a macro against a conversation (no side effects)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/macros/{id}/preview","href":"/api-reference/all-endpoints/inbox/preview-a-macro-against-a-conversation-no-side-effects"},{"title":"AI macro suggestions for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{convId}/macro-suggestions","href":"/api-reference/all-endpoints/inbox/ai-macro-suggestions-for-a-conversation"},{"title":"List analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/macros/analytics","href":"/api-reference/all-endpoints/inbox/list-analytics"},{"title":"List trends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/macros/analytics/trends","href":"/api-reference/all-endpoints/inbox/list-trends"},{"title":"List conversation tag definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tags","href":"/api-reference/all-endpoints/inbox/list-conversation-tag-definitions"},{"title":"Create a conversation tag definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tags","href":"/api-reference/all-endpoints/inbox/create-a-conversation-tag-definition"},{"title":"Update a conversation tag definition (rename / recolor)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/tags/{id}","href":"/api-reference/all-endpoints/inbox/update-a-conversation-tag-definition-rename-recolor"},{"title":"Archive (soft-delete) a conversation tag definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tags/{id}/archive","href":"/api-reference/all-endpoints/inbox/archive-soft-delete-a-conversation-tag-definition"},{"title":"Restore an archived conversation tag definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tags/{id}/unarchive","href":"/api-reference/all-endpoints/inbox/restore-an-archived-conversation-tag-definition"},{"title":"List macro-folders for the calling user + team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/macro-folders","href":"/api-reference/all-endpoints/inbox/list-macro-folders-for-the-calling-user-+-team"},{"title":"Create a macro-folder","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/macro-folders","href":"/api-reference/all-endpoints/inbox/create-a-macro-folder"},{"title":"Delete a macro-folder (nested macros become unfiled)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/macro-folders/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-macro-folder-nested-macros-become-unfiled"},{"title":"Update a macro-folder","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/macro-folders/{id}","href":"/api-reference/all-endpoints/inbox/update-a-macro-folder"},{"title":"List pending scheduled replies for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{convId}/scheduled-replies","href":"/api-reference/all-endpoints/inbox/list-pending-scheduled-replies-for-a-conversation"},{"title":"Schedule a reply (or rendered macro) to send at a future time","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{convId}/scheduled-replies","href":"/api-reference/all-endpoints/inbox/schedule-a-reply-or-rendered-macro-to-send-at-a-future-time"},{"title":"Cancel a pending scheduled inbox reply","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/scheduled-replies/{id}","href":"/api-reference/all-endpoints/inbox/cancel-a-pending-scheduled-inbox-reply"},{"title":"Bulk action across many conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/bulk","href":"/api-reference/all-endpoints/inbox/bulk-action-across-many-conversations"},{"title":"Undo a recent bulk action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/bulk/undo","href":"/api-reference/all-endpoints/inbox/undo-a-recent-bulk-action"},{"title":"Send one reply across many conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/bulk/reply","href":"/api-reference/all-endpoints/inbox/send-one-reply-across-many-conversations"},{"title":"Split selected messages into a new conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/split","href":"/api-reference/all-endpoints/inbox/split-selected-messages-into-a-new-conversation"},{"title":"List inbox SLA policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/sla/policies","href":"/api-reference/all-endpoints/inbox/list-inbox-sla-policies"},{"title":"Create an inbox SLA policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/sla/policies","href":"/api-reference/all-endpoints/inbox/create-an-inbox-sla-policy"},{"title":"Delete an inbox SLA policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/sla/policies/{id}","href":"/api-reference/all-endpoints/inbox/delete-an-inbox-sla-policy"},{"title":"Update an inbox SLA policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/sla/policies/{id}","href":"/api-reference/all-endpoints/inbox/update-an-inbox-sla-policy"},{"title":"Compute the SLA state (due-at, breach flags) for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/sla/conversations/{conversationId}","href":"/api-reference/all-endpoints/inbox/compute-the-sla-state-due-at-breach-flags-for-a-conversation"},{"title":"Test-send a configured SLA breach action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/sla/policies/test-action","href":"/api-reference/all-endpoints/inbox/test-send-a-configured-sla-breach-action"},{"title":"Blended cross-channel SLA status + SLA-aware routing weights","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/sla/blended","href":"/api-reference/all-endpoints/inbox/blended-cross-channel-sla-status-+-sla-aware-routing-weights"},{"title":"Unified newest-first SLA breach-alert feed (first-response, resolution, next-response)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/sla/breach-events","href":"/api-reference/all-endpoints/inbox/unified-newest-first-sla-breach-alert-feed-first-response-resolution-next-response"},{"title":"Bulk-evaluate SLA timers for a page of conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/sla/timers","href":"/api-reference/all-endpoints/inbox/bulk-evaluate-sla-timers-for-a-page-of-conversations"},{"title":"Acknowledge fired SLA breach alerts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/sla/breaches/ack","href":"/api-reference/all-endpoints/inbox/acknowledge-fired-sla-breach-alerts"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/team-performance/agents","href":"/api-reference/all-endpoints/inbox/list-agents"},{"title":"List trends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/team-performance/trends","href":"/api-reference/all-endpoints/inbox/list-trends-1"},{"title":"Merged timeline of customer conversations + internal team channels + DMs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/unified","href":"/api-reference/all-endpoints/inbox/merged-timeline-of-customer-conversations-+-internal-team-channels-+-dms"},{"title":"Warm-transfer a customer conversation to another employee (presence-checked)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/transfer-to-employee","href":"/api-reference/all-endpoints/inbox/warm-transfer-a-customer-conversation-to-another-employee-presence-checked"},{"title":"Live digital-channel team wallboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/wallboard","href":"/api-reference/all-endpoints/inbox/live-digital-channel-team-wallboard"},{"title":"Ingest a public social mention into the omnichannel inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/social-mentions/ingest","href":"/api-reference/all-endpoints/inbox/ingest-a-public-social-mention-into-the-omnichannel-inbox"},{"title":"List the public social-mention triage queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/social-mentions","href":"/api-reference/all-endpoints/inbox/list-the-public-social-mention-triage-queue"},{"title":"AI reply-coach suggestions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/reply-suggestions","href":"/api-reference/all-endpoints/inbox/ai-reply-coach-suggestions"},{"title":"AI reply-coach suggestions (streaming)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/{conversationId}/reply-suggestions/stream","href":"/api-reference/all-endpoints/inbox/ai-reply-coach-suggestions-streaming"},{"title":"Live rolling thread summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{conversationId}/live-summary","href":"/api-reference/all-endpoints/inbox/live-rolling-thread-summary"},{"title":"Submit a reply for supervisor approval","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/replies/queue","href":"/api-reference/all-endpoints/inbox/submit-a-reply-for-supervisor-approval"},{"title":"List pending reply approvals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/replies/pending","href":"/api-reference/all-endpoints/inbox/list-pending-reply-approvals"},{"title":"Approve a pending reply","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/replies/{id}/approve","href":"/api-reference/all-endpoints/inbox/approve-a-pending-reply"},{"title":"Reject a pending reply","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/replies/{id}/reject","href":"/api-reference/all-endpoints/inbox/reject-a-pending-reply"},{"title":"Get reply-approval settings for the caller","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/replies/settings","href":"/api-reference/all-endpoints/inbox/get-reply-approval-settings-for-the-caller"},{"title":"Set an agent's reply-approval requirement","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/replies/settings/{userId}","href":"/api-reference/all-endpoints/inbox/set-an-agents-reply-approval-requirement"},{"title":"Translate an inbound message body on demand","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/messages/{id}/translate","href":"/api-reference/all-endpoints/inbox/translate-an-inbound-message-body-on-demand"},{"title":"Translate an outbound agent draft to the customer's preferred locale","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/reply/translate","href":"/api-reference/all-endpoints/inbox/translate-an-outbound-agent-draft-to-the-customers-preferred-locale"},{"title":"AI ticket deflection — match KB article + suggest answer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/deflect","href":"/api-reference/all-endpoints/inbox/ai-ticket-deflection-—-match-kb-article-+-suggest-answer"},{"title":"AI ticket deflection — customer accepted","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/deflect/accept","href":"/api-reference/all-endpoints/inbox/ai-ticket-deflection-—-customer-accepted"},{"title":"AI ticket deflection — customer escalated","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/deflect/escalate","href":"/api-reference/all-endpoints/inbox/ai-ticket-deflection-—-customer-escalated"},{"title":"AI ticket deflection — customer confirmation (Yes/No solved?)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/deflect/confirm","href":"/api-reference/all-endpoints/inbox/ai-ticket-deflection-—-customer-confirmation-yesno-solved?"},{"title":"List clustered deflection-miss knowledge gaps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/knowledge-gaps","href":"/api-reference/all-endpoints/inbox/list-clustered-deflection-miss-knowledge-gaps"},{"title":"Promote a knowledge-gap cluster to a draft KB article","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/knowledge-gaps/{clusterId}/promote","href":"/api-reference/all-endpoints/inbox/promote-a-knowledge-gap-cluster-to-a-draft-kb-article"},{"title":"Per-article deflection success-rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-deflection/article-stats","href":"/api-reference/all-endpoints/inbox/per-article-deflection-success-rate"},{"title":"Aggregate AI deflection stats grouped by KB article (Intercom-Fin parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/deflection/stats","href":"/api-reference/all-endpoints/inbox/aggregate-ai-deflection-stats-grouped-by-kb-article-intercom-fin-parity"},{"title":"Per-article thumbs feedback on the deflection card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-deflection/article-feedback","href":"/api-reference/all-endpoints/inbox/per-article-thumbs-feedback-on-the-deflection-card"},{"title":"AI-deflection budget config + live monthly usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ai-deflection/budget","href":"/api-reference/all-endpoints/inbox/ai-deflection-budget-config-+-live-monthly-usage"},{"title":"Update the tenant's AI-deflection budget config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/ai-deflection/budget","href":"/api-reference/all-endpoints/inbox/update-the-tenants-ai-deflection-budget-config"},{"title":"AI ticket-deflection config (kill switch + thresholds)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-deflection/config","href":"/api-reference/all-endpoints/inbox/ai-ticket-deflection-config-kill-switch-+-thresholds"},{"title":"Update the tenant's AI ticket-deflection config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/ticket-deflection/config","href":"/api-reference/all-endpoints/inbox/update-the-tenants-ai-ticket-deflection-config"},{"title":"Deflection ROI savings (configurable window)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/deflection/savings","href":"/api-reference/all-endpoints/inbox/deflection-roi-savings-configurable-window"},{"title":"AI reply-draft suggestion (CHAIN3 — CPaaS→AIaaS)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{conversationId}/ai-draft","href":"/api-reference/all-endpoints/inbox/ai-reply-draft-suggestion-chain3-—-cpaas→aiaas"},{"title":"Inbox co-pilot config (kill switch + auto-approve bar)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/copilot/config","href":"/api-reference/all-endpoints/inbox/inbox-co-pilot-config-kill-switch-+-auto-approve-bar"},{"title":"Update the tenant's inbox co-pilot config","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/copilot/config","href":"/api-reference/all-endpoints/inbox/update-the-tenants-inbox-co-pilot-config"},{"title":"Record AI-draft outcome (retraining-loop telemetry)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{conversationId}/ai-draft/outcome","href":"/api-reference/all-endpoints/inbox/record-ai-draft-outcome-retraining-loop-telemetry"},{"title":"Record operator feedback on an AI-draft suggestion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ai-drafts/{conversationId}/feedback","href":"/api-reference/all-endpoints/inbox/record-operator-feedback-on-an-ai-draft-suggestion"},{"title":"AI-draft feedback rollup (per-agent or per-template)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ai-drafts/feedback/aggregate","href":"/api-reference/all-endpoints/inbox/ai-draft-feedback-rollup-per-agent-or-per-template"},{"title":"List conversations flagged for coaching review","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/coaching/queue","href":"/api-reference/all-endpoints/inbox/list-conversations-flagged-for-coaching-review"},{"title":"List coaching notes on a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{id}/coaching-notes","href":"/api-reference/all-endpoints/inbox/list-coaching-notes-on-a-conversation"},{"title":"Attach a coaching note to a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/coaching-notes","href":"/api-reference/all-endpoints/inbox/attach-a-coaching-note-to-a-conversation"},{"title":"Acknowledge a coaching note","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/conversations/{id}/coaching-notes/{noteId}/acknowledge","href":"/api-reference/all-endpoints/inbox/acknowledge-a-coaching-note"},{"title":"Get an agent's QM scorecard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/agents/{agentId}/scorecard","href":"/api-reference/all-endpoints/inbox/get-an-agents-qm-scorecard"},{"title":"List coaching-effectiveness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/agents/{agentId}/coaching-effectiveness","href":"/api-reference/all-endpoints/inbox/list-coaching-effectiveness"},{"title":"Get the QM leaderboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/leaderboard","href":"/api-reference/all-endpoints/inbox/get-the-qm-leaderboard"},{"title":"Supervisor live assist copilot (SSE) for a text thread","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{conversationId}/supervisor-assist/stream","href":"/api-reference/all-endpoints/inbox/supervisor-live-assist-copilot-sse-for-a-text-thread"},{"title":"Start a supervisor takeover of a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/takeover/start","href":"/api-reference/all-endpoints/inbox/start-a-supervisor-takeover-of-a-conversation"},{"title":"Send a reply during supervisor takeover","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/takeover/send-reply","href":"/api-reference/all-endpoints/inbox/send-a-reply-during-supervisor-takeover"},{"title":"End a supervisor takeover of a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{id}/takeover/end","href":"/api-reference/all-endpoints/inbox/end-a-supervisor-takeover-of-a-conversation"},{"title":"Get the current takeover state of a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{id}/takeover","href":"/api-reference/all-endpoints/inbox/get-the-current-takeover-state-of-a-conversation"},{"title":"List all disposition taxonomies for this tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/dispositions/taxonomies","href":"/api-reference/all-endpoints/inbox/list-all-disposition-taxonomies-for-this-tenant"},{"title":"Create a disposition taxonomy (admin/owner only)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/dispositions/taxonomies","href":"/api-reference/all-endpoints/inbox/create-a-disposition-taxonomy-adminowner-only"},{"title":"Update a disposition taxonomy (admin/owner only)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/dispositions/taxonomies/{taxonomyId}","href":"/api-reference/all-endpoints/inbox/update-a-disposition-taxonomy-adminowner-only"},{"title":"Manually set or override the disposition for a closed conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{conversationId}/disposition","href":"/api-reference/all-endpoints/inbox/manually-set-or-override-the-disposition-for-a-closed-conversation"},{"title":"Label distribution + AI confidence histogram + override rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/dispositions/stats","href":"/api-reference/all-endpoints/inbox/label-distribution-+-ai-confidence-histogram-+-override-rate"},{"title":"List the tenant's disposition-lifecycle transition edges","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/dispositions/lifecycle/rules","href":"/api-reference/all-endpoints/inbox/list-the-tenants-disposition-lifecycle-transition-edges"},{"title":"Create a disposition-lifecycle transition edge (owner/admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/dispositions/lifecycle/rules","href":"/api-reference/all-endpoints/inbox/create-a-disposition-lifecycle-transition-edge-owneradmin"},{"title":"Remove a disposition-lifecycle transition edge (owner/admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/dispositions/lifecycle/rules/{ruleId}","href":"/api-reference/all-endpoints/inbox/remove-a-disposition-lifecycle-transition-edge-owneradmin"},{"title":"Current disposition-lifecycle state + full transition history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{conversationId}/disposition-state","href":"/api-reference/all-endpoints/inbox/current-disposition-lifecycle-state-+-full-transition-history"},{"title":"Record a disposition-lifecycle transition for a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/conversations/{conversationId}/disposition-state","href":"/api-reference/all-endpoints/inbox/record-a-disposition-lifecycle-transition-for-a-conversation"},{"title":"List tenant-defined conversation intelligence operators","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/intelligence/operators","href":"/api-reference/all-endpoints/inbox/list-tenant-defined-conversation-intelligence-operators"},{"title":"Create a conversation intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/intelligence/operators","href":"/api-reference/all-endpoints/inbox/create-a-conversation-intelligence-operator-adminowner"},{"title":"Deactivate a conversation intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/intelligence/operators/{id}","href":"/api-reference/all-endpoints/inbox/deactivate-a-conversation-intelligence-operator-adminowner"},{"title":"Update a conversation intelligence operator (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/intelligence/operators/{id}","href":"/api-reference/all-endpoints/inbox/update-a-conversation-intelligence-operator-adminowner"},{"title":"Operator results tagged on a single conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/conversations/{id}/intelligence/operators","href":"/api-reference/all-endpoints/inbox/operator-results-tagged-on-a-single-conversation"},{"title":"List inbox tickets for the tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets","href":"/api-reference/all-endpoints/inbox/list-inbox-tickets-for-the-tenant"},{"title":"List B2B companies / accounts with ticket roll-up stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/companies","href":"/api-reference/all-endpoints/inbox/list-b2b-companies-accounts-with-ticket-roll-up-stats"},{"title":"Export inbox tickets (CSV or JSON)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/export","href":"/api-reference/all-endpoints/inbox/export-inbox-tickets-csv-or-json"},{"title":"Fetch the ticket (if any) associated with a call","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/by-call/{callId}","href":"/api-reference/all-endpoints/inbox/fetch-the-ticket-if-any-associated-with-a-call"},{"title":"Fetch a single ticket by id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}","href":"/api-reference/all-endpoints/inbox/fetch-a-single-ticket-by-id"},{"title":"Delete a ticket (owner/admin only)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/tickets/{id}","href":"/api-reference/all-endpoints/inbox/delete-a-ticket-owneradmin-only"},{"title":"Update an existing ticket (status / priority / assignee)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/tickets/{id}","href":"/api-reference/all-endpoints/inbox/update-an-existing-ticket-status-priority-assignee"},{"title":"Create an inbox ticket (internal path, CHAIN1 stub)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/internal","href":"/api-reference/all-endpoints/inbox/create-an-inbox-ticket-internal-path-chain1-stub"},{"title":"Accrue active agent handle-time onto a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/handle-time","href":"/api-reference/all-endpoints/inbox/accrue-active-agent-handle-time-onto-a-ticket"},{"title":"Reopen a resolved or wont_fix ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/reopen","href":"/api-reference/all-endpoints/inbox/reopen-a-resolved-or-wont_fix-ticket"},{"title":"Auto-assign an unassigned ticket via capacity-aware round-robin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/assign-auto","href":"/api-reference/all-endpoints/inbox/auto-assign-an-unassigned-ticket-via-capacity-aware-round-robin"},{"title":"Route an unassigned ticket through an ACD queue to a blended agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/route-through-queue","href":"/api-reference/all-endpoints/inbox/route-an-unassigned-ticket-through-an-acd-queue-to-a-blended-agent"},{"title":"List comments on a ticket (CSPaaS P0 — BT-CSPAAS)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/comments","href":"/api-reference/all-endpoints/inbox/list-comments-on-a-ticket-cspaas-p0-—-bt-cspaas"},{"title":"Create a comment on a ticket (CSPaaS P0 — BT-CSPAAS)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/comments","href":"/api-reference/all-endpoints/inbox/create-a-comment-on-a-ticket-cspaas-p0-—-bt-cspaas"},{"title":"List a ticket's field-change activity timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/history","href":"/api-reference/all-endpoints/inbox/list-a-tickets-field-change-activity-timeline"},{"title":"Run a macro against a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/run-macro","href":"/api-reference/all-endpoints/inbox/run-a-macro-against-a-ticket"},{"title":"List the operators following a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{ticketId}/followers","href":"/api-reference/all-endpoints/inbox/list-the-operators-following-a-ticket"},{"title":"Subscribe an operator to a ticket's lifecycle updates","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{ticketId}/followers","href":"/api-reference/all-endpoints/inbox/subscribe-an-operator-to-a-tickets-lifecycle-updates"},{"title":"Unsubscribe an operator from a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/tickets/{ticketId}/followers/{userId}","href":"/api-reference/all-endpoints/inbox/unsubscribe-an-operator-from-a-ticket"},{"title":"Merge ticket :id (source) into target_id (Zendesk parity)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/merge","href":"/api-reference/all-endpoints/inbox/merge-ticket-:id-source-into-target_id-zendesk-parity"},{"title":"Create a link / parent edge between two tickets","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/link","href":"/api-reference/all-endpoints/inbox/create-a-link-parent-edge-between-two-tickets"},{"title":"List every edge touching this ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/links","href":"/api-reference/all-endpoints/inbox/list-every-edge-touching-this-ticket"},{"title":"List ticket tag definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-tags","href":"/api-reference/all-endpoints/inbox/list-ticket-tag-definitions"},{"title":"Create a ticket tag definition (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-tags","href":"/api-reference/all-endpoints/inbox/create-a-ticket-tag-definition-adminowner"},{"title":"Patch a ticket tag definition (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/ticket-tags/{id}","href":"/api-reference/all-endpoints/inbox/patch-a-ticket-tag-definition-adminowner"},{"title":"Archive a ticket tag definition (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-tags/{id}/archive","href":"/api-reference/all-endpoints/inbox/archive-a-ticket-tag-definition-adminowner"},{"title":"Restore an archived ticket tag (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-tags/{id}/unarchive","href":"/api-reference/all-endpoints/inbox/restore-an-archived-ticket-tag-adminowner"},{"title":"List ticket custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/ticket-custom-fields","href":"/api-reference/all-endpoints/inbox/list-ticket-custom-field-definitions"},{"title":"Create a ticket custom field definition (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-custom-fields","href":"/api-reference/all-endpoints/inbox/create-a-ticket-custom-field-definition-adminowner"},{"title":"Patch a ticket custom field definition (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/inbox/ticket-custom-fields/{id}","href":"/api-reference/all-endpoints/inbox/patch-a-ticket-custom-field-definition-adminowner"},{"title":"Archive a ticket custom field (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-custom-fields/{id}/archive","href":"/api-reference/all-endpoints/inbox/archive-a-ticket-custom-field-adminowner"},{"title":"Restore an archived ticket custom field (admin/owner)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/ticket-custom-fields/{id}/unarchive","href":"/api-reference/all-endpoints/inbox/restore-an-archived-ticket-custom-field-adminowner"},{"title":"Replace tags on a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/tickets/{id}/tags","href":"/api-reference/all-endpoints/inbox/replace-tags-on-a-ticket"},{"title":"Replace custom field values on a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/inbox/tickets/{id}/custom-fields","href":"/api-reference/all-endpoints/inbox/replace-custom-field-values-on-a-ticket"},{"title":"List attachments on a ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/attachments","href":"/api-reference/all-endpoints/inbox/list-attachments-on-a-ticket"},{"title":"Register an attachment and mint a signed upload URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/attachments","href":"/api-reference/all-endpoints/inbox/register-an-attachment-and-mint-a-signed-upload-url"},{"title":"Download a ticket attachment's bytes through the API","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/attachments/{attId}/content","href":"/api-reference/all-endpoints/inbox/download-a-ticket-attachments-bytes-through-the-api"},{"title":"Upload the bytes for a registered ticket attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/{id}/attachments/{attId}/content","href":"/api-reference/all-endpoints/inbox/upload-the-bytes-for-a-registered-ticket-attachment"},{"title":"Mint a signed download URL for a ticket attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/inbox/tickets/{id}/attachments/{attId}/url","href":"/api-reference/all-endpoints/inbox/mint-a-signed-download-url-for-a-ticket-attachment"},{"title":"Delete a ticket attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/inbox/tickets/{id}/attachments/{attId}","href":"/api-reference/all-endpoints/inbox/delete-a-ticket-attachment"},{"title":"Bulk-update tickets (assign / set_status / set_priority / set_type)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/inbox/tickets/bulk","href":"/api-reference/all-endpoints/inbox/bulk-update-tickets-assign-set_status-set_priority-set_type"}]},{"group":"Teams","pages":[{"title":"List teams for the current tenant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/teams","href":"/api-reference/all-endpoints/teams/list-teams-for-the-current-tenant"},{"title":"Create a new team","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/teams","href":"/api-reference/all-endpoints/teams/create-a-new-team"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/teams/{id}","href":"/api-reference/all-endpoints/teams/delete-a-team"},{"title":"Update a team","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/teams/{id}","href":"/api-reference/all-endpoints/teams/update-a-team"},{"title":"List members of a team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/teams/{id}/members","href":"/api-reference/all-endpoints/teams/list-members-of-a-team"},{"title":"Add a member to a team","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/teams/{id}/members","href":"/api-reference/all-endpoints/teams/add-a-member-to-a-team"},{"title":"Remove a member from a team","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/teams/{id}/members/{userId}","href":"/api-reference/all-endpoints/teams/remove-a-member-from-a-team"}]},{"group":"TeamChat","pages":[{"title":"Upload a file attachment for team chat","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/attachments","href":"/api-reference/all-endpoints/teamchat/upload-a-file-attachment-for-team-chat"},{"title":"List internal team channels the caller is a member of","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels","href":"/api-reference/all-endpoints/teamchat/list-internal-team-channels-the-caller-is-a-member-of"},{"title":"Create an internal team channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels","href":"/api-reference/all-endpoints/teamchat/create-an-internal-team-channel"},{"title":"List members of a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels/{channelId}/members","href":"/api-reference/all-endpoints/teamchat/list-members-of-a-channel"},{"title":"Add a member to a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/members","href":"/api-reference/all-endpoints/teamchat/add-a-member-to-a-channel"},{"title":"Remove a member from a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/channels/{channelId}/members/{userId}","href":"/api-reference/all-endpoints/teamchat/remove-a-member-from-a-channel"},{"title":"Full-text search messages across your channels and Direct Messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/search","href":"/api-reference/all-endpoints/teamchat/full-text-search-messages-across-your-channels-and-direct-messages"},{"title":"List channel messages, newest-first","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels/{channelId}/messages","href":"/api-reference/all-endpoints/teamchat/list-channel-messages-newest-first"},{"title":"Post a message to a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/messages","href":"/api-reference/all-endpoints/teamchat/post-a-message-to-a-channel"},{"title":"Reply in-thread to a channel message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/messages/{messageId}/replies","href":"/api-reference/all-endpoints/teamchat/reply-in-thread-to-a-channel-message"},{"title":"Load a channel message thread (root + replies)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels/{channelId}/messages/{messageId}/thread","href":"/api-reference/all-endpoints/teamchat/load-a-channel-message-thread-root-+-replies"},{"title":"Soft-delete a channel message (own message, or any as channel owner/admin)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/channels/{channelId}/messages/{messageId}","href":"/api-reference/all-endpoints/teamchat/soft-delete-a-channel-message-own-message-or-any-as-channel-owneradmin"},{"title":"Edit your own channel message","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/team-chat/channels/{channelId}/messages/{messageId}","href":"/api-reference/all-endpoints/teamchat/edit-your-own-channel-message"},{"title":"Mark a channel read (advances the caller's per-channel read cursor)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/read","href":"/api-reference/all-endpoints/teamchat/mark-a-channel-read-advances-the-callers-per-channel-read-cursor"},{"title":"Delete a channel and all of its messages (owner only)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/channels/{channelId}","href":"/api-reference/all-endpoints/teamchat/delete-a-channel-and-all-of-its-messages-owner-only"},{"title":"Get the active huddle (if any) for a channel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels/{channelId}/huddle","href":"/api-reference/all-endpoints/teamchat/get-the-active-huddle-if-any-for-a-channel"},{"title":"Start a huddle in a channel, or drop into the live one","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/huddle","href":"/api-reference/all-endpoints/teamchat/start-a-huddle-in-a-channel-or-drop-into-the-live-one"},{"title":"Leave the channel huddle (ends it when the room empties)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/huddle/leave","href":"/api-reference/all-endpoints/teamchat/leave-the-channel-huddle-ends-it-when-the-room-empties"},{"title":"List DM threads the caller participates in","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/dms","href":"/api-reference/all-endpoints/teamchat/list-dm-threads-the-caller-participates-in"},{"title":"Open (get-or-create) a 1:1 DM thread with another user","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/dms","href":"/api-reference/all-endpoints/teamchat/open-get-or-create-a-1:1-dm-thread-with-another-user"},{"title":"List messages in a DM thread","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/dms/{threadId}/messages","href":"/api-reference/all-endpoints/teamchat/list-messages-in-a-dm-thread"},{"title":"Send a message in a DM thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/dms/{threadId}/messages","href":"/api-reference/all-endpoints/teamchat/send-a-message-in-a-dm-thread"},{"title":"Soft-delete your own DM message","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/dms/{threadId}/messages/{messageId}","href":"/api-reference/all-endpoints/teamchat/soft-delete-your-own-dm-message"},{"title":"Edit your own DM message","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/team-chat/dms/{threadId}/messages/{messageId}","href":"/api-reference/all-endpoints/teamchat/edit-your-own-dm-message"},{"title":"Mark inbound DM messages in a thread as read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/dms/{threadId}/read","href":"/api-reference/all-endpoints/teamchat/mark-inbound-dm-messages-in-a-thread-as-read"},{"title":"Delete a DM thread and all of its messages (participant)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/dms/{threadId}","href":"/api-reference/all-endpoints/teamchat/delete-a-dm-thread-and-all-of-its-messages-participant"},{"title":"Refresh the caller's presence (online/away)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/presence/heartbeat","href":"/api-reference/all-endpoints/teamchat/refresh-the-callers-presence-onlineaway"},{"title":"Snapshot of online peers (+ last-seen for requested users)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/presence","href":"/api-reference/all-endpoints/teamchat/snapshot-of-online-peers-+-last-seen-for-requested-users"},{"title":"Mark the caller offline (graceful disconnect)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/presence","href":"/api-reference/all-endpoints/teamchat/mark-the-caller-offline-graceful-disconnect"},{"title":"Broadcast a typing indicator to a channel or DM peer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/typing","href":"/api-reference/all-endpoints/teamchat/broadcast-a-typing-indicator-to-a-channel-or-dm-peer"},{"title":"Batch reaction summary for channel messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/channels/{channelId}/messages/reactions","href":"/api-reference/all-endpoints/teamchat/batch-reaction-summary-for-channel-messages"},{"title":"Add a reaction to a channel message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/channels/{channelId}/messages/{messageId}/reactions","href":"/api-reference/all-endpoints/teamchat/add-a-reaction-to-a-channel-message"},{"title":"Remove your reaction from a channel message","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/channels/{channelId}/messages/{messageId}/reactions/{emoji}","href":"/api-reference/all-endpoints/teamchat/remove-your-reaction-from-a-channel-message"},{"title":"Batch reaction summary for DM messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/team-chat/dms/{threadId}/messages/reactions","href":"/api-reference/all-endpoints/teamchat/batch-reaction-summary-for-dm-messages"},{"title":"Add a reaction to a DM message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/team-chat/dms/{threadId}/messages/{messageId}/reactions","href":"/api-reference/all-endpoints/teamchat/add-a-reaction-to-a-dm-message"},{"title":"Remove your reaction from a DM message","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/team-chat/dms/{threadId}/messages/{messageId}/reactions/{emoji}","href":"/api-reference/all-endpoints/teamchat/remove-your-reaction-from-a-dm-message"}]},{"group":"Quality","pages":[{"title":"Org-wide quality-management summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/summary","href":"/api-reference/all-endpoints/quality/org-wide-quality-management-summary"},{"title":"Org-wide QA score trend series","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/trends","href":"/api-reference/all-endpoints/quality/org-wide-qa-score-trend-series"},{"title":"Per-criterion QA driver averages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/drivers","href":"/api-reference/all-endpoints/quality/per-criterion-qa-driver-averages"},{"title":"Per-agent coaching cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/coaching-cards","href":"/api-reference/all-endpoints/quality/per-agent-coaching-cards"},{"title":"Compliance-flagged QA evaluations queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/compliance-flags","href":"/api-reference/all-endpoints/quality/compliance-flagged-qa-evaluations-queue"},{"title":"List evaluation forms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/evaluation-forms","href":"/api-reference/all-endpoints/quality/list-evaluation-forms"},{"title":"Create an evaluation form","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluation-forms","href":"/api-reference/all-endpoints/quality/create-an-evaluation-form"},{"title":"Get an evaluation form","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/evaluation-forms/{id}","href":"/api-reference/all-endpoints/quality/get-an-evaluation-form"},{"title":"Update an evaluation form","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/quality/evaluation-forms/{id}","href":"/api-reference/all-endpoints/quality/update-an-evaluation-form"},{"title":"List evaluations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/evaluations","href":"/api-reference/all-endpoints/quality/list-evaluations"},{"title":"Create an evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations","href":"/api-reference/all-endpoints/quality/create-an-evaluation"},{"title":"Create a self-evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/self","href":"/api-reference/all-endpoints/quality/create-a-self-evaluation"},{"title":"Compare self vs reviewer scores for a call","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/evaluations/variance","href":"/api-reference/all-endpoints/quality/compare-self-vs-reviewer-scores-for-a-call"},{"title":"Acknowledge an evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/acknowledge","href":"/api-reference/all-endpoints/quality/acknowledge-an-evaluation"},{"title":"Appeal an evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/appeal","href":"/api-reference/all-endpoints/quality/appeal-an-evaluation"},{"title":"Resolve an appealed evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/resolve","href":"/api-reference/all-endpoints/quality/resolve-an-appealed-evaluation"},{"title":"Claim and score an auto-queued evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/claim-score","href":"/api-reference/all-endpoints/quality/claim-and-score-an-auto-queued-evaluation"},{"title":"Override an AI-scored evaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/override","href":"/api-reference/all-endpoints/quality/override-an-ai-scored-evaluation"},{"title":"AI auto-QA coverage rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/autoscore-coverage","href":"/api-reference/all-endpoints/quality/ai-auto-qa-coverage-rollup"},{"title":"Search the post-call recording/transcript library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/recording-library","href":"/api-reference/all-endpoints/quality/search-the-post-call-recordingtranscript-library"},{"title":"List calibration sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/calibrations","href":"/api-reference/all-endpoints/quality/list-calibration-sessions"},{"title":"Create a calibration session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/calibrations","href":"/api-reference/all-endpoints/quality/create-a-calibration-session"},{"title":"Get a calibration session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/calibrations/{id}","href":"/api-reference/all-endpoints/quality/get-a-calibration-session"},{"title":"Submit a blind calibration score","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/calibrations/{id}/scores","href":"/api-reference/all-endpoints/quality/submit-a-blind-calibration-score"},{"title":"Get the calibration agreement report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/calibrations/{id}/report","href":"/api-reference/all-endpoints/quality/get-the-calibration-agreement-report"},{"title":"Close a calibration session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/calibrations/{id}/close","href":"/api-reference/all-endpoints/quality/close-a-calibration-session"},{"title":"Get gamification config defaults","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/gamification/config","href":"/api-reference/all-endpoints/quality/get-gamification-config-defaults"},{"title":"Get my gamification card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/gamification/me","href":"/api-reference/all-endpoints/quality/get-my-gamification-card"},{"title":"Compute the agent leaderboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/gamification/leaderboard","href":"/api-reference/all-endpoints/quality/compute-the-agent-leaderboard"},{"title":"Compute a weighted supervisor scorecard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/scorecards/composite","href":"/api-reference/all-endpoints/quality/compute-a-weighted-supervisor-scorecard"},{"title":"List coaching-rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/coaching-rules","href":"/api-reference/all-endpoints/quality/list-coaching-rules"},{"title":"List auto-qa-readiness","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/auto-qa-readiness","href":"/api-reference/all-endpoints/quality/list-auto-qa-readiness"},{"title":"Assign a QA evaluation to a specific evaluator","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/assign","href":"/api-reference/all-endpoints/quality/assign-a-qa-evaluation-to-a-specific-evaluator"},{"title":"Reassign an open evaluation to a different evaluator","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/quality/evaluations/{id}/reassign","href":"/api-reference/all-endpoints/quality/reassign-an-open-evaluation-to-a-different-evaluator"},{"title":"Per-evaluator QA assignment workload","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/quality/evaluations/workload","href":"/api-reference/all-endpoints/quality/per-evaluator-qa-assignment-workload"}]},{"group":"Loyalty","pages":[{"title":"Get the loyalty program","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/loyalty/program","href":"/api-reference/all-endpoints/loyalty/get-the-loyalty-program"},{"title":"Update the loyalty program","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/v1/loyalty/program","href":"/api-reference/all-endpoints/loyalty/update-the-loyalty-program"},{"title":"Create the loyalty program","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/loyalty/program","href":"/api-reference/all-endpoints/loyalty/create-the-loyalty-program"},{"title":"Reset the loyalty program","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/loyalty/program","href":"/api-reference/all-endpoints/loyalty/reset-the-loyalty-program"},{"title":"Preview loyalty","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/loyalty/preview","href":"/api-reference/all-endpoints/loyalty/preview-loyalty"},{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/loyalty/members","href":"/api-reference/all-endpoints/loyalty/list-members"},{"title":"Get members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/loyalty/members/{contactId}","href":"/api-reference/all-endpoints/loyalty/get-members"},{"title":"Create redeem","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/loyalty/members/{contactId}/redeem","href":"/api-reference/all-endpoints/loyalty/create-redeem"},{"title":"Create adjust","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/loyalty/members/{contactId}/adjust","href":"/api-reference/all-endpoints/loyalty/create-adjust"}]},{"group":"Orby","pages":[{"title":"Start or continue an Orby assistant turn (SSE stream)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/assistant","href":"/api-reference/all-endpoints/orby/start-or-continue-an-orby-assistant-turn-sse-stream"},{"title":"List the operator's Orby threads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/orby/threads","href":"/api-reference/all-endpoints/orby/list-the-operators-orby-threads"},{"title":"Create an Orby thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/threads","href":"/api-reference/all-endpoints/orby/create-an-orby-thread"},{"title":"List an Orby thread's messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/orby/threads/{id}/messages","href":"/api-reference/all-endpoints/orby/list-an-orby-threads-messages"},{"title":"Search the Orbit knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/orby/kb/search","href":"/api-reference/all-endpoints/orby/search-the-orbit-knowledge-base"},{"title":"Find the dashboard setting for a described task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/kb/find-setting","href":"/api-reference/all-endpoints/orby/find-the-dashboard-setting-for-a-described-task"},{"title":"Trigger an Orby knowledge-base reindex","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/kb/reindex","href":"/api-reference/all-endpoints/orby/trigger-an-orby-knowledge-base-reindex"},{"title":"Get Orby knowledge-base index status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/orby/kb/status","href":"/api-reference/all-endpoints/orby/get-orby-knowledge-base-index-status"},{"title":"Approve a pending Orby tool action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/tool-actions/{id}/approve","href":"/api-reference/all-endpoints/orby/approve-a-pending-orby-tool-action"},{"title":"Reject a pending Orby tool action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/orby/tool-actions/{id}/reject","href":"/api-reference/all-endpoints/orby/reject-a-pending-orby-tool-action"},{"title":"Get a pending Orby tool action","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/orby/tool-actions/{id}","href":"/api-reference/all-endpoints/orby/get-a-pending-orby-tool-action"}]}]}]},{"tab":"SDKs","groups":[{"group":"SDKs","pages":[{"title":"Orbit SDK status: Node, Web, Go, .NET, Java, Python, PHP, Ruby","href":"/sdks"},{"title":"SDK language plans — which escape hatch per language, and which cookbook to use","href":"/guides/sdk-language-plans"},{"title":"Node.js SDK: Orbit quickstart for JavaScript and TypeScript","href":"/sdks/node"},{"title":"Web SDK: embed Orbit messaging and voice in browsers","href":"/sdks/web"},{"title":"Python SDK: Orbit quickstart for Python","href":"/sdks/python"},{"title":"Go SDK: Orbit quickstart for Go","href":"/sdks/go"},{"title":"Ruby SDK: Orbit quickstart for Ruby","href":"/sdks/ruby"},{"title":"PHP SDK: Orbit quickstart for PHP","href":"/sdks/php"},{"title":"Java SDK: Orbit quickstart for Java","href":"/sdks/java"},{"title":".NET SDK: Orbit quickstart for C#","href":"/sdks/csharp"},{"title":"Swift SDK: Orbit quickstart for iOS","href":"/sdks/swift"},{"title":"Android SDK: Orbit quickstart for Kotlin","href":"/sdks/android"},{"title":"Flutter SDK: Orbit quickstart for Dart","href":"/sdks/flutter"},{"title":"React Native SDK: Orbit quickstart","href":"/sdks/react-native"},{"title":"InAppEventType: the in-app event enum and the aliasing rejections","href":"/guides/inapp-event-type-contract"}]}]},{"tab":"Reference","groups":[{"group":"Reference","pages":[{"title":"Programmable Voice DSL: verbs for answer_url call control","href":"/reference/programmable-voice-dsl"},{"title":"Error Code Reference","href":"/reference/error-codes"},{"title":"INVALID_PHONE_NUMBER","href":"/errors/INVALID_PHONE_NUMBER"},{"title":"RATE_LIMITED","href":"/errors/RATE_LIMITED"},{"title":"VALIDATION_ERROR","href":"/errors/VALIDATION_ERROR"},{"title":"UNAUTHORIZED","href":"/errors/UNAUTHORIZED"},{"title":"ALREADY_EXISTS","href":"/errors/ALREADY_EXISTS"},{"title":"SERVICE_UNAVAILABLE","href":"/errors/SERVICE_UNAVAILABLE"},{"title":"INTERNAL_ERROR","href":"/errors/INTERNAL_ERROR"},{"title":"CLIENT_DISCONNECTED","href":"/errors/CLIENT_DISCONNECTED"},{"title":"Troubleshooting hub","href":"/reference/troubleshooting-hub"},{"title":"Troubleshooting: message stuck in queued (full cause table)","href":"/reference/troubleshooting"},{"title":"Troubleshoot system and 5xx error codes","href":"/reference/troubleshooting-system-5xx"},{"title":"Webhook events reference: payload fields and event types","href":"/reference/webhook-events"},{"title":"Orbit CPaaS glossary: messaging, voice, and flows terms","href":"/reference/glossary"},{"title":"Opt-Out Keyword Aliases","href":"/reference/opt-out-keyword-alias-reference"},{"title":"Frequently Asked Questions","href":"/reference/faq"},{"title":"Endpoint overlays","href":"/reference/endpoint-overlays"},{"title":"Notifications hub","href":"/notifications/overview"},{"group":"Inbox assignment and lifecycle","pages":[{"title":"Troubleshooting: inbox assignment stuck pending, and auto-close timing","href":"/troubleshooting/inbox-assignment-and-auto-close"},{"title":"Troubleshooting: ATTACHMENT_STORAGE_UNAVAILABLE","href":"/troubleshooting/attachment-storage-unavailable"},{"title":"Presence federation: decode degraded sync states and API failures","href":"/troubleshooting/presence-federation-states"},{"title":"Social mentions not arriving","href":"/troubleshooting/social-mentions-not-arriving"}]},{"group":"Widget and capture surfaces","pages":[{"title":"Session replay failures: empty playback, corrupt recordings, and offload 503s","href":"/troubleshooting/session-replay-failures"},{"title":"Widget and ambient-agent action refusals","href":"/troubleshooting/widget-agent-action-refusals"}]},{"group":"Messaging queues and receipts","pages":[{"title":"Troubleshooting: message parked before sending","href":"/troubleshooting/message-queued"},{"title":"Troubleshooting: a scheduled message that never fired","href":"/troubleshooting/scheduled-send-never-fired"},{"title":"Troubleshooting: message sent but no delivery receipt","href":"/troubleshooting/submitted-no-receipt"},{"title":"Troubleshooting: DLR retry and late-receipt recovery","href":"/troubleshooting/failed-dlr-recovery"},{"title":"Troubleshooting: message undelivered or failed","href":"/troubleshooting/message-undelivered-failed"},{"title":"Troubleshooting: SMS to a landline skipped before sending","href":"/troubleshooting/landline-sms-line-type-filter"},{"title":"Troubleshooting: number masking and proxy-session failures","href":"/troubleshooting/number-masking-proxy-session"},{"title":"Troubleshoot number lookup and messaging-service resolution failures","href":"/troubleshooting/number-lookup-and-messaging-service-failures"},{"title":"Troubleshoot Lookup per-field verdicts (200 with coming_soon/not_implemented/error)","href":"/troubleshooting/number-lookup-per-field-verdicts"},{"title":"Troubleshooting: validation gate codes","href":"/troubleshooting/validation-gates"},{"title":"Troubleshooting: channel and conversation pre-send refusals (CHANNEL_REQUIRED, CHANNEL_COMING_SOON, CHANNEL_NOT_REPLYABLE, CONVERSATION_NOT_FOUND, CONVERSATION_MISMATCH)","href":"/troubleshooting/channel-and-conversation-refusals"},{"title":"Troubleshooting: SMPP bind rejects and command_status codes","href":"/troubleshooting/smpp-bind-and-command-status-codes"},{"title":"Troubleshoot SMPP_BACKEND_UNAVAILABLE (503)","href":"/troubleshooting/smpp-credential-provisioning-unavailable"},{"title":"Troubleshooting: CHANNEL_UNAVAILABLE and fallback chain exhaustion","href":"/troubleshooting/channel-unavailable-fallback-exhausted"},{"title":"Short link not resolving or LINK_NOT_FOUND","href":"/troubleshooting/short-links-not-resolving"}]},{"group":"Internal collaboration","pages":[{"title":"Team Chat and Huddle state surprises","href":"/troubleshooting/team-chat-huddle-availability"}]},{"group":"Surveys and VoC","pages":[{"title":"Troubleshoot survey dispatch, signed links, and frequency-cap skips","href":"/troubleshooting/surveys-voc-lifecycle"}]},{"group":"Push","pages":[{"title":"Troubleshooting: push token expiry — APNs 410, FCM InvalidToken, and UNREGISTERED","href":"/troubleshooting/push-token-expiry"},{"title":"Troubleshoot push broadcast pre-send gates (BROADCAST_TOO_LARGE, CHANNEL_RATE_LIMITED)","href":"/troubleshooting/push-broadcast-caps"}]},{"group":"Numbers and sender identity","pages":[{"title":"Troubleshoot number purchase failures: inventory races and provisioning retries","href":"/troubleshooting/numbers-provisioning-failed"},{"title":"Number stuck in pending_compliance: why it happens and what un-sticks it","href":"/troubleshooting/number-pending-compliance"},{"title":"Troubleshooting: connectivity SIM events — usage gates, lifecycle stream, and a silent webhook","href":"/troubleshooting/connectivity-sim-events"},{"title":"Troubleshoot CARRIER_RATE_LIMITED on bulk number purchase","href":"/troubleshooting/bulk-purchase-carrier-rate-limit"},{"title":"Troubleshoot port-out rejections: PIN gate and carrier failures","href":"/troubleshooting/port-out-blocked"},{"title":"Troubleshooting: number warming caps (DAILY_CAP_EXCEEDED, WARMING_QUOTA_EXCEEDED, NUMBER_MPS_EXCEEDED)","href":"/troubleshooting/number-warming-caps"},{"title":"Troubleshooting: sender warm-up pacing — a stalled or slow sender with no 429","href":"/troubleshooting/sender-warmup-pacing"},{"title":"Troubleshooting: alphanumeric sender ID rejected before send","href":"/troubleshooting/sender-id-not-registered"},{"title":"Troubleshoot a pending number or Sender ID","href":"/compliance/troubleshooting-pending-gated-surfaces"},{"title":"Troubleshoot a 'blocked' send — map the code to the gate","href":"/compliance/troubleshooting-blocked-class-errors"},{"title":"Compliance profile lifecycle errors — INCOMPLETE, REQUIRED, NOT_APPROVED, LOCKED, IN_USE","href":"/compliance/compliance-profile-lifecycle-errors"},{"title":"Compliance send-gate error codes — decide the gate, own the fix, re-verify","href":"/compliance/troubleshooting-compliance-error-codes"},{"title":"Send-gate decision fork — which check rejected your send","href":"/compliance/send-gate-decision-fork"},{"title":"Troubleshooting: Sender-ID registration rejected or expired","href":"/troubleshooting/sender-id-registration-resubmit"},{"title":"Troubleshooting: US toll-free sender blocked with TFV_REQUIRED","href":"/troubleshooting/toll-free-tfv-required"},{"title":"Troubleshooting: sender and asset preflight gates","href":"/troubleshooting/sender-asset-preflight-gates"},{"title":"Troubleshoot India DLT gate 422 rejects (dlt_template_id)","href":"/troubleshooting/in-dlt-gates"},{"title":"Troubleshooting: 10DLC campaign rejected","href":"/troubleshooting/10dlc-campaign-rejection"},{"title":"Troubleshooting: TEN_DLC_NOT_REGISTERED on US SMS sends","href":"/troubleshooting/ten-dlc-not-registered"},{"title":"Troubleshoot eSIM activation and purchase failures (reseller lane)","href":"/troubleshooting/esim-activation-failures"}]},{"group":"Voice","pages":[{"title":"Troubleshooting: SIP trunk registration, health, and failover","href":"/troubleshooting/sip-trunk"},{"title":"Troubleshooting: outbound calls rejected with SBC_UNAVAILABLE","href":"/troubleshooting/outbound-call-sbc-unavailable"},{"title":"Troubleshooting: SIP_CREDENTIAL_NOT_REGISTERED on click-to-call","href":"/troubleshooting/sip-credential-not-on-call"},{"title":"Troubleshooting: voice call quality — one-way audio, dead air, jitter, and PDD","href":"/troubleshooting/voice-call-quality"},{"title":"Troubleshooting: VOICE_GATEWAY_ERROR (502) at call-send","href":"/troubleshooting/voice-gateway-error"},{"title":"Troubleshooting: secure-payment capture failures","href":"/troubleshooting/secure-payment-capture"},{"title":"Troubleshooting: payment-mandate confirmation failures","href":"/troubleshooting/voice-payment-mandate-confirmations"},{"title":"Troubleshooting: supervisor takeover, whisper, and barge failures","href":"/troubleshooting/supervisor-takeover-failures"},{"title":"Troubleshooting: in-call AI handoff, deflection, and follow-up failures","href":"/troubleshooting/voice-ai-handoff-deflect-followup"},{"title":"Troubleshooting: voice agent dispatch eligibility","href":"/troubleshooting/voice-agent-dispatch-eligibility"},{"title":"Troubleshooting: resolve dialing-window blocked voice calls","href":"/troubleshooting/tcpa-window-blocked-calls"},{"title":"Troubleshooting: FCC AI-voice consent gate blocking outbound calls","href":"/troubleshooting/fcc-ai-voice-blocked-calls"},{"title":"Troubleshooting: TCPA voice-guard sentinel breadcrumbs","href":"/troubleshooting/voice-window-sentinel-breadcrumbs"},{"title":"Troubleshooting: quiet-hours blocks that fired during allowed hours","href":"/troubleshooting/quiet-hours-false-positives"},{"title":"Troubleshooting: voice destination and emergency blocks","href":"/troubleshooting/voice-destination-blocks"},{"title":"Troubleshooting: routing and channel misconfiguration","href":"/troubleshooting/routing-and-channel-misconfig"},{"title":"Troubleshooting: queue capacity gates","href":"/troubleshooting/queue-capacity-gates"},{"title":"Troubleshooting: queue SLA forecast callback gate","href":"/troubleshooting/queue-sla-callback-gate"},{"title":"Troubleshooting: queue emergency activation 422 EMERGENCY_DESTINATION_REQUIRED","href":"/troubleshooting/queue-emergency-activation-422"},{"title":"Troubleshooting: queue booking failed","href":"/troubleshooting/queue-booking-failed"},{"title":"Troubleshooting: disposition and wrap-up errors","href":"/troubleshooting/disposition-and-wrap-up-errors"},{"title":"Troubleshooting: voice biometrics failures","href":"/troubleshooting/voice-biometrics-failures"},{"title":"Troubleshooting: transcription, synthesis, and deepfake failures","href":"/troubleshooting/transcription-and-synthetic-voice-failures"},{"title":"Live interpretation failures","href":"/troubleshooting/live-interpretation-failures"},{"title":"Troubleshooting: agent outbound-call and voice-clone guard codes","href":"/troubleshooting/agent-outbound-guards"},{"title":"Troubleshooting: voice inference credential rejected","href":"/troubleshooting/voice-inference-credential-rejected"}]},{"group":"Compliance and deliverability gates","pages":[{"title":"401 REAUTH_REQUIRED on destructive operations","href":"/troubleshooting/reauth-challenge-flow"},{"title":"Troubleshooting: messaging pre-send gates (blocked contacts, quiet hours, session windows, deactivated numbers)","href":"/troubleshooting/messaging-pre-send-gates"},{"title":"Troubleshooting: EMAIL_TEST_RECIPIENT_NOT_VERIFIED — the shared-account email test-mode gate","href":"/troubleshooting/email-test-recipient-not-verified"},{"title":"Troubleshooting: DNC pre-flight returns 403 DNC_SYNC_NOT_ENABLED","href":"/troubleshooting/dnc-check-gated"},{"title":"Troubleshooting: CONSENT_RECEIPT_INVALID (422)","href":"/troubleshooting/consent-receipt-invalid"},{"title":"Troubleshooting: BYOK_KEY_UNAVAILABLE (409) and DECRYPTION_FAILED (502)","href":"/troubleshooting/byok-key-unavailable"},{"title":"Troubleshooting: ENCRYPTION_FAILED (5xx) and DECRYPTION_FAILED (502)","href":"/troubleshooting/encryption-envelope-failures"},{"title":"Troubleshooting: imported opt-outs still get messages — check the scope","href":"/troubleshooting/suppression-scope-mismatch"},{"title":"Troubleshooting: SMS destination and spending blocks","href":"/troubleshooting/sms-destination-blocks"},{"title":"Troubleshoot strict sender-ID mode rejects (SENDER_INVALID_FOR_DESTINATION)","href":"/troubleshooting/strict-sender-id-invalid-destination"},{"title":"Troubleshoot Mexico NOM-184 consent gate 422 rejects","href":"/troubleshooting/mx-nom184-consent"},{"title":"Troubleshooting: pending-compliance and erasure gates","href":"/troubleshooting/pending-compliance-and-erasure-gates"},{"title":"Troubleshooting: proof-of-deletion certificate errors","href":"/troubleshooting/dsar-erasure-certificate-errors"},{"title":"Troubleshooting: routing and channel misconfiguration","href":"/troubleshooting/routing-and-channel-misconfig"},{"title":"Troubleshooting: archival channel enablement","href":"/troubleshooting/archival-channel-enablement"},{"title":"Troubleshooting: RESIDENCY_* data-residency errors (409/404)","href":"/troubleshooting/data-residency-errors"},{"title":"Sends blocked by the reassigned-number gate — 422 MESSAGING_RND_REASSIGNED","href":"/troubleshooting/rnd-reassigned-blocked-send"}]},{"group":"Outbound","pages":[{"title":"Troubleshooting: opt-out list label conflicts","href":"/troubleshooting/opt-out-list-label-conflict"}]},{"group":"Webhooks","pages":[{"title":"Troubleshooting: failed webhook deliveries, retries, DLQ, and replay","href":"/troubleshooting/webhook-deliveries"},{"title":"Troubleshooting: webhook endpoint creation errors","href":"/troubleshooting/webhook-endpoint-creation"},{"title":"Troubleshooting: webhook endpoint cap and DNS pre-create gates","href":"/troubleshooting/webhook-endpoint-cap-and-dns-pre-create"},{"title":"Troubleshooting: duplicate webhook events and consumer-side dedup","href":"/troubleshooting/webhook-event-dedup"},{"title":"Troubleshooting: webhook ordering and fan-out — out-of-order application under at-least-once","href":"/troubleshooting/webhook-ordering-fanout"},{"title":"Troubleshooting: webhook lifecycle error codes","href":"/troubleshooting/webhook-lifecycle-codes"},{"title":"Troubleshooting: webhook signature verification fails (HMAC mismatch)","href":"/troubleshooting/webhook-signature-invalid"},{"title":"Troubleshooting: Integration webhook receiver returns 503","href":"/troubleshooting/integration-webhook-receiver-disabled"}]},{"group":"Verify","pages":[{"title":"Troubleshooting: Verify OTP sends and checks failing","href":"/troubleshooting/verify-otp"},{"title":"Troubleshooting: Verify factor suite (TOTP, push, passkey, backup codes)","href":"/troubleshooting/verify-factor-suite"},{"title":"Troubleshooting: BINDING_REQUIRED / BINDING_MISMATCH on Verify","href":"/troubleshooting/verify-binding-gates"},{"title":"Troubleshooting: caller-ID verification rejects","href":"/troubleshooting/verifications-rejects"},{"title":"KBA caller-verification session errors: decode the seven codes and fix the session","href":"/troubleshooting/kba-caller-verification"}]},{"group":"Email","pages":[{"title":"Troubleshooting: email bounces and spam complaints","href":"/troubleshooting/email-bounces-complaints"},{"title":"Troubleshooting: email DNS verification drift and recovery","href":"/troubleshooting/email-dns-drift"},{"title":"Sub-account billing emails not arriving: a triage runbook","href":"/troubleshooting/subaccount-email-notifications-routing"},{"title":"Troubleshooting: inbound email never routes","href":"/guides/inbound-email-troubleshooting"}]},{"group":"Run a freemail domain","pages":[{"title":"Email suppression event payloads: worked examples","href":"/guides/email-suppression-event-payloads"}]},{"group":"Billing and account gates","pages":[{"title":"Troubleshoot billing recovery codes (PAYMENT_REQUIRED, INSUFFICIENT_FUNDS, AUTO_TOPUP_payment/cap codes)","href":"/troubleshooting/billing-recovery-codes"},{"title":"Troubleshoot spend-cap refusals (SMS_DAILY_SPEND_CAP, CHANNEL_DAILY_SPEND_CAP, VOICE_DAILY_SPEND_CAP, CAMPAIGN_VOICE_SPEND_CAP_REACHED)","href":"/troubleshooting/spend-caps-hit"},{"title":"Troubleshoot subaccount budget refusals (SUBACCOUNT_CHANNEL_BUDGET_EXCEEDED, SUBACCOUNT_MONTHLY_SPEND_CAP_EXCEEDED)","href":"/troubleshooting/subaccount-budget-and-spend-caps"},{"title":"Troubleshoot the automatic security pause after unusual spend activity","href":"/troubleshooting/security-pause-suspended"},{"title":"Troubleshoot NUMBER_MONTHLY_SPEND_CAP_EXCEEDED (402)","href":"/troubleshooting/number-monthly-spend-cap"},{"title":"Troubleshoot squad and conversation cost caps (SQUAD_DAILY_CAP_REACHED, CONVERSATION_COST_CAP_REACHED)","href":"/troubleshooting/squad-and-conversation-cost-caps"},{"title":"Troubleshoot INSUFFICIENT_BALANCE (402)","href":"/troubleshooting/insufficient-balance"},{"title":"Troubleshooting: billing-gate outbound blocks","href":"/troubleshooting/billing-pause-block-recovery"},{"title":"Troubleshoot pricing-gate errors (PRICING_NOT_CONFIGURED, PRICING_FX_*, PRICING_RATE_*, PRICING_OVERRIDE_SLOT_CONFLICT, PRICING_UPLOAD_STALE_CONFLICT)","href":"/troubleshooting/pricing-gates"},{"title":"Troubleshoot send-price and country gates (MAX_PRICE_EXCEEDED, COUNTRY_NOT_ALLOWED)","href":"/troubleshooting/send-price-and-country-gates"},{"title":"Troubleshooting: routing and channel misconfiguration","href":"/troubleshooting/routing-and-channel-misconfig"}]},{"group":"Platform roads and queues","pages":[{"title":"Troubleshooting: authentication, key mode, and IP allowlist failures","href":"/troubleshooting/auth-and-api-keys"},{"title":"Troubleshooting: TURNSTILE_REQUIRED (422) on public form endpoints","href":"/troubleshooting/turnstile-required"},{"title":"Troubleshooting: SAML SSO and SCIM setup failures","href":"/troubleshooting/sso-and-scim-setup-failures"},{"title":"Troubleshooting: API_HOST_RETIRED (410) on a legacy API host","href":"/troubleshooting/retired-api-host-410"},{"title":"Troubleshooting: ACCOUNT_LOCKED at dashboard sign-in","href":"/troubleshooting/account-locked-login"},{"title":"Troubleshooting: password rejected during password reset","href":"/troubleshooting/password-reset-policy-rejected"},{"title":"FAQ: per-user state, share-link revocation, and send-time experiments","href":"/troubleshooting/per-user-and-auth-lifecycle-faq"},{"title":"Troubleshooting: DOMAIN_NOT_FOUND on your branded console","href":"/troubleshooting/resolve-domain-not-found"},{"title":"Troubleshooting: support access (view-as) token failures","href":"/troubleshooting/support-access-impersonation"},{"title":"Troubleshooting: agent runtime errors","href":"/troubleshooting/agent-errors"},{"title":"Troubleshooting: SAFETY_CLASSIFIER_REFUSAL, AGENT_CHANNEL_CAP_EXCEEDED, and EMPTY_AUDIENCE_NOT_ALLOWED","href":"/troubleshooting/ai-guardrail-refusals-and-audience-blocks"},{"title":"Troubleshooting: Agent Studio graph and custom-tool validation","href":"/troubleshooting/agent-graph-and-custom-tools"},{"title":"Troubleshooting: LLM timeouts and upstream failures on agent runs and IVR NLU","href":"/troubleshooting/llm-upstream-failures"},{"title":"Troubleshooting: IVR NLU classifier and slot-extraction failures","href":"/troubleshooting/ivr-nlu-llm-failures"},{"title":"Troubleshooting: IVR NLU intent catalogue authoring rejections","href":"/troubleshooting/ivr-nlu-catalog-rejections"},{"title":"Troubleshooting: A2A federation discovery and peer tasks","href":"/troubleshooting/a2a-federation"},{"title":"Troubleshooting: MCP server registration rejected","href":"/troubleshooting/mcp-server-registration"},{"title":"Troubleshooting: Orby operator errors","href":"/troubleshooting/orby-operator-errors"},{"title":"Troubleshooting: Orby pending-action approval","href":"/troubleshooting/orby-tool-approval"},{"title":"Troubleshoot TENANT_SCHEMA_INCOMPLETE (503)","href":"/troubleshooting/tenant-schema-incomplete-503"},{"title":"Troubleshoot 503 UNDER_PRESSURE — when the platform sheds load","href":"/troubleshooting/platform-load-shed-503"},{"title":"Troubleshoot tenant provisioning lifecycle codes","href":"/troubleshooting/tenant-provisioning-lifecycle"},{"title":"Troubleshooting: DOMAIN_NOT_FOUND (404) on a branded console and public resolve","href":"/troubleshooting/domain-not-found-branded-resolve"},{"title":"Troubleshoot the dashboard error fallback page","href":"/troubleshooting/dashboard-error-fallback"},{"title":"Troubleshooting: cooldown and rate-limit 429s","href":"/troubleshooting/rate-limits"},{"title":"Troubleshooting: contact imports","href":"/troubleshooting/import-jobs"},{"title":"Troubleshooting: a flow execution that failed","href":"/troubleshooting/flow-executions-failed"},{"title":"Troubleshooting: recording integrity, legal hold, and QC failures","href":"/troubleshooting/recording-integrity-and-legal-hold"}]},{"group":"Channels and integrations","pages":[{"title":"Troubleshooting: inbound SMS to your number never arrives","href":"/troubleshooting/inbound-sms-no-route"},{"title":"Troubleshooting: inbound WhatsApp or RCS message never arrives","href":"/troubleshooting/inbound-channels-no-route"},{"title":"Troubleshooting: LINE, Kakao, WeChat, and Zalo inbound never arrives","href":"/troubleshooting/apac-channel-inbound-no-route"},{"title":"Troubleshooting: Viber inbound and routing failures","href":"/troubleshooting/viber-inbound-and-route-failures"},{"title":"Troubleshooting: Türkiye SMS with a URL arrives stripped or empty","href":"/troubleshooting/turkiye-url-strip"},{"title":"Troubleshooting: LINE inbound events never arrive","href":"/troubleshooting/line-webhook-setup"},{"title":"Troubleshooting: KakaoTalk Alimtalk 422 and Friendtalk body rejects","href":"/troubleshooting/kakao-template-gates"},{"title":"Troubleshooting: WeChat and Zalo CHANNEL_NOT_CONFIGURED and credential precedence","href":"/troubleshooting/wechat-zalo-credentials"},{"title":"Troubleshooting: RCS undelivered or never reaching an RCS-capable device","href":"/troubleshooting/rcs-undelivered"},{"title":"Troubleshooting: RCS BRAND_NOT_APPROVED (409)","href":"/troubleshooting/rcs-brand-not-approved"},{"title":"Troubleshooting: RCS tester invite 425 PENDING_ACCEPTANCE and 422 INVITE_DECLINED","href":"/troubleshooting/rcs-tester-invite"},{"title":"Troubleshooting: WhatsApp Business Calling pre-flight gates","href":"/troubleshooting/whatsapp-calling-gates"},{"title":"Troubleshooting: WhatsApp 24-hour session expired (WHATSAPP_SESSION_EXPIRED)","href":"/troubleshooting/whatsapp-session-expired"},{"title":"Troubleshooting: USSD menu, callback, and simulate","href":"/troubleshooting/ussd-menu-callback"},{"title":"Troubleshooting: Telegram channel errors","href":"/troubleshooting/telegram-connect"},{"title":"Troubleshooting: Messenger and Instagram 24-hour window closed (MESSAGING_WINDOW_CLOSED)","href":"/troubleshooting/messenger-window-closed"},{"title":"Troubleshooting: Messenger channel not connected (409 MESSENGER_NOT_CONNECTED)","href":"/troubleshooting/messenger-not-connected"},{"title":"Troubleshooting: Slack connection and sync failures (SLACK_TOKEN_*)","href":"/troubleshooting/slack-connect-and-sync"},{"title":"Troubleshooting: Apple Messages for Business onboarding and send failures","href":"/troubleshooting/apple-messages"},{"title":"Troubleshooting: CRM integration sync error codes","href":"/troubleshooting/crm-integration-errors"},{"title":"Troubleshooting: Integration action and sync error codes","href":"/troubleshooting/integration-action-sync-errors"},{"title":"Troubleshooting: wallet pass generation counter and void conflict","href":"/troubleshooting/wallet-pass-lifecycle"},{"title":"Troubleshooting: fax sends fail or never arrive","href":"/troubleshooting/fax-send-failures"},{"title":"Fax lifecycle orchestration: inbound and outbound legs","href":"/guides/fax-lifecycle-orchestration"}]},{"group":"Ads","pages":[{"title":"Troubleshooting: Ads hub failures","href":"/troubleshooting/ads-hub-failures"}]},{"group":"Audience and segments","pages":[{"title":"Troubleshooting: segment auto-suggest failures (AI_SUGGEST_FAILED)","href":"/troubleshooting/ai-suggest-failed"},{"title":"Activation approval state errors","href":"/troubleshooting/activation-approvals"},{"title":"Troubleshooting: SAFETY_CLASSIFIER_REFUSAL, AGENT_CHANNEL_CAP_EXCEEDED, and EMPTY_AUDIENCE_NOT_ALLOWED","href":"/troubleshooting/ai-guardrail-refusals-and-audience-blocks"},{"title":"Contact create conflicts: duplicate and archived contacts","href":"/troubleshooting/contact-create-conflicts"}]},{"group":"CDP / event ingest","pages":[{"title":"Troubleshooting: TRACKING_PLAN_VIOLATION on CDP ingest","href":"/troubleshooting/tracking-plan-violations"}]},{"group":"Everything else","pages":[{"title":"Troubleshooting: agent eval-queue failures","href":"/troubleshooting/agent-eval-queue"},{"title":"Troubleshooting: prompt-regression rejects an agent-version rollback","href":"/troubleshooting/agent-prompt-regression-registered"},{"title":"Promotion gate blocked a version (PROMOTION_GATE_FAILED / RED_TEAM_GATE_FAILED)","href":"/troubleshooting/agent-promotion-gate-blocks"},{"title":"Troubleshooting: Interactions search export 403s and pagination oddities","href":"/troubleshooting/interactions-list.csv-export"},{"title":"Troubleshooting: merge refused with WEAK_IDENTITY_MATCH_REQUIRES_CONFIRMATION","href":"/troubleshooting/conversation-merge"},{"title":"Troubleshooting: co-browse session stuck","href":"/troubleshooting/cobrowse-stuck"},{"title":"Troubleshooting: page shows nothing — an order or import stuck in an enqueued state","href":"/troubleshooting/enqueued-empty-states"},{"title":"Troubleshooting: FILE_SCAN_QUARANTINED","href":"/troubleshooting/file-scan-quarantined"},{"title":"Troubleshooting: DSAR export, decrypt, and cancel failures","href":"/troubleshooting/dsar-export-failures"},{"title":"Glossary internal links that 404","href":"/troubleshooting/glossary-link-404"},{"title":"Customer share link returns not found","href":"/troubleshooting/public-share-link-404"},{"title":"Troubleshooting: QR code render failures (400, 422, or 502)","href":"/troubleshooting/qr-codes-render-failures"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: idempotency, balance re-entry, and auto-top-up gates","href":"/troubleshooting/idempotency-and-billing-gates"}]},{"group":"Ungrouped","pages":[{"title":"Video room features: chat, polls, Q\u0026A, invites, RTMP","href":"/troubleshooting/video-features-chat-polls-rtmp"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: video room and call quality — WebRTC, recording QC, and SIP dial-out","href":"/troubleshooting/video-call-quality"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: video echo and codec mismatch — distorted, delayed, and looping audio in rooms","href":"/troubleshooting/video-echo-codec"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: video room lifecycle failures — joins, capacity, lobby, agent dispatch, and RTMP egress","href":"/troubleshooting/video-room-lifecycle"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: Webinar registration and registrant lifecycle errors","href":"/troubleshooting/webinar-registration-registrant-errors"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: video guest chat refusals — VIDEO_CHAT_GUEST_FORBIDDEN, VIDEO_CHAT_LOBBY_HELD, and VIDEO_CHAT_LOBBY_CHECK_UNAVAILABLE","href":"/troubleshooting/video-chat-guest-forbidden"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: video waiting-room and lobby errors — VIDEO_CHAT_LOBBY_HELD, VIDEO_WAITING_ROOM_DENY_FAILED, and the guest refusal path","href":"/troubleshooting/video-waiting-room-and-lobby"}]},{"group":"Ungrouped","pages":[{"title":"Video avatar agent and render errors","href":"/troubleshooting/video-avatar-agents"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: conference lifecycle failures","href":"/troubleshooting/conference-failures"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: fan-out and upload errors","href":"/troubleshooting/fan-out-and-upload-errors"},{"title":"Troubleshooting: MEDIA_UPLOAD_FAILED","href":"/troubleshooting/media-upload-failed"},{"title":"Troubleshooting: ATTACHMENT_TOO_LARGE and AUDIO_TOO_LARGE","href":"/troubleshooting/attachment-size-caps"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: call fails right after a regional failover or failback","href":"/troubleshooting/media-planes-failover-or-failback"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: state mini-TCPA blocked voice calls","href":"/troubleshooting/tcpa-state-mini-tcpa-window-blocked-calls"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: STIR/SHAKEN attestation stuck at C — spam-likely treatment, delegate certificates, and RCD","href":"/troubleshooting/stir-shaken-attestation-downgrade"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: STIR/SHAKEN never measured — the get-your-level quick start","href":"/troubleshooting/stir-shaken-not-measured"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: RMD filing flagged deficient, overdue, or unexpectedly withdrawn","href":"/troubleshooting/rmd-filing-deficiency-or-expired"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: voice call park orbit","href":"/troubleshooting/voice-call-park"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: MCID flag failures","href":"/troubleshooting/mcid-flag-failures"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: call flip and call pickup","href":"/troubleshooting/conference-flip-pickup"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: hot-desking sign-in rejects","href":"/troubleshooting/hot-desking-sign-in-rejects"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: hoteling reservation cancel and revoke rejections","href":"/troubleshooting/hoteling-reservation-cancel-rejects"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: dialer preview, power, and predictive modes not advancing","href":"/troubleshooting/dialer-preview"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: outbound campaign blocked at the pre-send gate chain","href":"/troubleshooting/voice-pre-send-gate-chain"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: transfer target restricted (VOICE_TRANSFER_TARGET_RESTRICTED)","href":"/troubleshooting/voice-transfer-target-restricted"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: inbound SMS not reaching your webhooks","href":"/troubleshooting/inbound-sms-not-recording"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: WhatsApp template pending, rejected, or blocked by the 24h window","href":"/troubleshooting/whatsapp-template"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshoot WHATSAPP_TEMPLATE_VAR_COUNT_MISMATCH","href":"/troubleshooting/whatsapp-template-var-count"},{"title":"Troubleshoot template composition errors (OVER_LENGTH, INVALID_BUTTON, INVALID_COMPONENT)","href":"/troubleshooting/template-composition-errors"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: campaign and journey enrollment errors","href":"/troubleshooting/campaign-journey-errors"},{"title":"Troubleshooting: campaign and conference state-machine transition errors","href":"/troubleshooting/campaign-conference-state-machine"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshoot sender resolution and pool errors","href":"/troubleshooting/sender-resolution-errors"},{"title":"Troubleshoot sender-ownership 422s (SENDER_NOT_OWNED)","href":"/troubleshooting/sender-ownership-blocked"}]},{"group":"Ungrouped","pages":[{"title":"Fix an empty sender pool (`SENDER_POOL_EMPTY`)","href":"/troubleshooting/sender-pool-empty"}]},{"group":"Ungrouped","pages":[{"title":"Fraud shield blocked","href":"/troubleshooting/fraud-shield-blocked"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: pool spread and anti-snowshoe alerts","href":"/troubleshooting/sender-pool-spread-alerts"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: WhatsApp connection, re-authentication, tier limits, and quality pauses","href":"/troubleshooting/whatsapp-connection"},{"title":"Troubleshooting: WhatsApp re-authentication and Embedded Sign-up recovery","href":"/troubleshooting/whatsapp-auth-and-connection-recovery"},{"title":"Troubleshooting: WhatsApp number registration — consumer app conflict and register failures","href":"/troubleshooting/whatsapp-registration-consumer-app"},{"title":"Troubleshooting: WhatsApp sends blocked by a WABA billing failure (WHATSAPP_BILLING_ISSUE)","href":"/troubleshooting/whatsapp-billing-issue"},{"title":"Troubleshooting: WhatsApp template library unavailable","href":"/troubleshooting/whatsapp-template-library-unavailable"},{"title":"Troubleshooting: WhatsApp campaign auto-paused on a RED quality rating (WHATSAPP_QUALITY_RED)","href":"/troubleshooting/whatsapp-quality-red-campaign-pause"},{"title":"Troubleshoot WhatsApp template lifecycle errors (132001, 132016, 132068, 133010)","href":"/troubleshooting/whatsapp-template-lifecycle-errors"},{"title":"Troubleshoot template rejection: TEMPLATE_REJECTED and WHATSAPP_TEMPLATE_REJECTED","href":"/troubleshooting/template-rejection-orbit-codes"},{"title":"Troubleshooting: WhatsApp test number held by another workspace (TEST_PHONE_REGISTERED_IN_OTHER_WORKSPACE)","href":"/troubleshooting/whatsapp-test-phone-occupied"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: WhatsApp migration stuck — verification, eligibility, template sync, webhooks","href":"/troubleshooting/whatsapp-migration"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: WhatsApp Flow submissions missing, empty, or stuck in the funnel","href":"/troubleshooting/whatsapp-flow-submissions"},{"title":"Troubleshooting: WhatsApp Flows API — 502 META_API_ERROR","href":"/troubleshooting/whatsapp-flows-meta-api-error"},{"title":"Troubleshooting: a Flow created from a template fails its first publish or test send","href":"/troubleshooting/whatsapp-flow-template-screens"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: content template has no variant for the channel (NO_VARIANT_FOR_CHANNEL)","href":"/troubleshooting/template-variant-missing"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: fallback chain names a channel with no variant (VALIDATION_ERROR)","href":"/troubleshooting/template-fallback-variant-missing"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: HIPAA_BAA_REQUIRED (422)","href":"/troubleshooting/phi-audience-baa-required"}]},{"group":"Ungrouped","pages":[{"title":"Troubleshooting: HIPAA enable blocked (403) until the BAA is executed","href":"/troubleshooting/hipaa-enable-baa-not-executed"}]}]}]}]},"basePath":"","title":"DSGVO-Verarbeitungsregister (ROPA + DPIA) - Devotel Orbit Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}