Skip to main content
The Platform API provides organization, project, billing, campaign, template, session, and embedded-signup operations under /v1/*.

​
Authentication

Each generated endpoint page lists its supported credential. Server automation operations accept a scoped titan_… organization key or a verified dashboard bearer. Operations that authorize an action by a specific member accept only a verified dashboard bearer. This dashboard-only group includes organization and member changes and message-template management. Organization and member changes and template create, update, and delete operations require an organization owner or admin. Template reads require active organization membership. Template responses identify drafts with id and createdAt. Template list responses contain at most 500 drafts. Project tokens (titan_pt_…) are rejected on /v1/*. For organization-key calls, the generated endpoint page lists the required scope in x-required-scope. Dashboard calls use the member’s current organization and authorization.

​
Public domains

The Platform API supports session management and testing numbers, campaign listing, message-template management, billing and usage reads, billing reminder settings, organization settings, projects, members, and embedded-signup settings. Use only the operations documented in the generated endpoint pages.

​
Embedded-signup settings

Organization-key callers use the widget permission represented by widget:create; dashboard callers use their active organization membership. Project tokens and client tokens are rejected. Pass projectId to read or update project-specific settings; omit it to use the organization defaults. See Manage saved settings for the supported fields.

​
Session-management operations

Organization-key callers need sessions:manage. Dashboard callers need current membership and authorization in the active organization. sessionId accepts a session UUID or a stable session slug up to 64 characters. Batch requests accept 1–100 unique identifiers. ids remains a deprecated compatibility alias for sessionIds. tierOverride is free, standard, pro, scale, or null to inherit the project plan. Testing-number country is US, GB, BR, or IN and defaults to US. name is an optional 1–100 character display name. Stop operations acknowledge an asynchronous stop request. Remove operations permanently remove the session and end its active connection when needed. The generated endpoint pages document the exact validation, not-found, and temporary service-error responses for each operation. Use the generated Platform API endpoints group for every path, parameter, body, response, and shared schema.