#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 do | Partner Team and Roles & Permissions |
| View or provision partner-managed clients | Clients |
| Create, rotate, or revoke API keys | API Keys & Partner API |
| Edit project configuration, runtime-domain settings, and publish changes | Projects |
| Manage outbound campaigns, CSV imports, launch validation, and campaign reporting | Outbound Campaigns |
| Understand webhooks, catalog, RAG/knowledge-base, phone-number, messaging, and plugin integration scope | Integrations |
| Know when to contact AiDial support | Escalation 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_admincan 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_userhas 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 surface | Partner admin | Partner user | Notes |
|---|---|---|---|
/partner-team | Manage team members and invitations for provisioned partner organisations | View team and assigned clients where partner bootstrap is complete | See Partner Team. |
/clients | Provision client profiles and assign partner users | View assigned clients | See Clients. |
/projects | Edit drafts, publish, restore versions, and manage implemented runtime-domain controls where enabled | View project workspace | See Projects. |
/outbound-campaigns | Create and manage campaigns, imports, validation, launch controls, and reporting for assigned clients | View safe campaign status and reports | See Outbound Campaigns. |
/integrations | Manage API keys; webhook/API and integration routes are available where enabled | View API-key inventory and enabled integration summaries | See Integrations. |
/capacity | View assigned-client capacity | View assigned-client capacity | Shared 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.
#Related References
- Tenant Scoping
- Roles & Permissions
- API Authentication
- Error Responses
- Project configuration lifecycle: use the Projects guide and your agreed partner escalation path for lifecycle questions.