#Partner Guides

Use these guides when your organisation manages AiDial clients as a partner. They cover the live partner portal surfaces, direct partner API usage, and the boundaries between partner self-service and AiDial support.

#Start Here

I want to...Read
Understand partner roles and what each role can doPartner Team and Roles & Permissions
View or provision partner-managed clientsClients
Create, rotate, or revoke API keysAPI Keys & Partner API
Edit project configuration, runtime-domain settings, and publish changesProjects
Manage outbound campaigns, CSV imports, launch validation, and campaign reportingOutbound Campaigns
Understand webhooks, catalog, RAG/knowledge-base, phone-number, messaging, and plugin integration scopeIntegrations
Know when to contact AiDial supportEscalation Boundaries

Shared customer-facing guides for Dashboard, Calls, Billing, Settings, Support, Status, and some operational views still live under Client Guides when the same page behaviour applies to partner roles.

#Current Partner Roles

  • partner_admin can manage implemented partner surfaces for assigned clients, including partner-team management, client provisioning and assignment, project workspace changes, API-key lifecycle, and supported integration mutations.
  • partner_user has read-only partner access where the portal exposes it. Partner users can view assigned operational state but cannot invite team members, create clients, assign users, publish projects, create or revoke API keys, or mutate integrations.

Navigation visibility is not the security boundary. Portal pages and route handlers enforce role, partner-organisation, client, and project scope server-side. Out-of-scope client or project requests are denied without revealing whether another tenant exists.

#Authentication Boundary

The browser uses the AiDial Portal session:

Browser -> AiDial Portal server -> AiDial API

Browser code must not send X-API-Key. Portal routes use the signed-in session and forward server-side bearer authentication to the AiDial API.

Direct partner integrations are different: trusted server-side systems authenticate to the AiDial API with API keys. See API Keys & Partner API and API Authentication.

#Implemented Partner Surfaces

Portal surfacePartner adminPartner userNotes
/partner-teamManage team members and invitations for provisioned partner organisationsView team and assigned clients where partner bootstrap is completeSee Partner Team.
/clientsProvision client profiles and assign partner usersView assigned clientsSee Clients.
/projectsEdit drafts, publish, restore versions, and manage implemented runtime-domain controls where enabledView project workspaceSee Projects.
/outbound-campaignsCreate and manage campaigns, imports, validation, launch controls, and reporting for assigned clientsView safe campaign status and reportsSee Outbound Campaigns.
/integrationsManage API keys; webhook/API and integration routes are available where enabledView API-key inventory and enabled integration summariesSee Integrations.
/capacityView assigned-client capacityView assigned-client capacityShared operational surface.

#Keep Internal Detail Internal

Partner docs should not include internal host access, secret-management paths, database maintenance, deployment templates, or customer secrets. When a workflow needs those controls, use Escalation Boundaries and provide safe context to AiDial support.