Free setup on annual plans
Sign up today!
Customers
API Reference: Customers endpoints
Overview
A customer is the tenant boundary for AnswerPal data. Use this page for account settings and model defaults. Related customer subresources are split into focused pages.
Current endpoints
Customer account endpoints
| Method | Path | Access | Purpose |
|---|---|---|---|
| GET | /api/Customers/me | Bearer JWT | Return the authenticated customer record as CustomerReadDTO. |
| PUT | /api/Customers/me | Bearer JWT | Update customer settings with CustomerUpdateDTO. |
| GET | /api/Customers/models | Bearer JWT | List active global and customer-specific AI models, plus selected inactive defaults. |
| GET | /api/Customers/my-secrets | PhoneAuthOnly | Return customer secrets for phone-auth flows. Not a general admin endpoint. |
Related customer endpoint pages
Access and security notes
Authorization: Bearer <token>. Phone-auth routes add a channel match requirement, while tokenized callbacks are public only for their scoped action.Fields and DTOs
Customer and model DTOs
CustomerUpdateDTO and CustomerBaseDTO
Body for customer account settings. Credential fields configure outbound services called by AnswerPal.
| Area | Fields | Notes |
|---|---|---|
| Outbound API connector | apiBaseUrl, apiUsername, apiPassword, apiToken, apiAuthenticationType | Not used for inbound AnswerPal API authentication. |
| Email provider | emailProviderType, graphTenantID, graphClientID, graphClientSecret, graphAuthorityURL, graphScope, imapServer, imapPort, imapUseSsl, smtpServer, smtpPort, smtpUseSsl | Graph and IMAP/SMTP account defaults. |
| Default models | defaultTopicModelId, defaultWebchatModelId, defaultEmailModelId, defaultCallModelId, defaultSpamModelId, defaultConditionalRulesModelId, defaultSummaryModelId, defaultRealtimeModelId, defaultRealtimeTranslationModelId, defaultTranscribeModelId | Updates validate visibility, active state and compatible model usage. |
| Internet access defaults | defaultEmailModelInternetAccessEnabled, defaultWebchatModelInternetAccessEnabled, defaultCallModelInternetAccessEnabled, defaultRealtimeModelInternetAccessEnabled | Per-channel default internet access flags. |
| Provider secrets | twilioAccountSID, twilioAuthToken, twilioRegion, openAIApiKey, openAIProjectId, openAIAdminApiKey, googleMapsApiKey, googleCloudProjectIds | External provider credentials and project IDs. |
| Operational defaults | defaultCustomerRepID, ticketCleanupRetentionDays | Retention must be at least 1 day. |
CustomerReadDTO and CustomerModelDTO
Returned by GET /api/Customers/me and GET /api/Customers/models.
| Area | Fields | Notes |
|---|---|---|
| Customer identity | customerID | Tenant boundary for all customer-scoped data. |
| Model identity | modelID, purpose, modelName, apiModelName | Model names and purpose metadata. |
| Modalities and capabilities | hasTextInput, hasImageInput, hasAudioInput, hasVideoInput, hasTextOutput, hasImageOutput, hasAudioOutput, hasVideoOutput, hasFunctionCalling, hasStreaming, hasSystemMessages, hasReasoning, supportsFineTuning, supportsWebSearch | Used by settings screens and runtime selection. |
| Availability | requiredSubscriptionLevel, isGlobal, isDefault, showInPrimaryList, compatibleUsages, isActive, isFineTuned | Visibility, default and compatibility metadata. |
Implementation note
Credential fields on this page configure outbound providers and connectors. They are not inbound AnswerPal API authentication.
Implementation note: customer data is scoped by the authenticated customer context. Do not send credentials in query strings, and treat secret fields as write-only or restricted wherever possible.
Table of Contents
AnswerPal: AI-powered customer service solutions to elevate your support and communication effortlessly.
Quick Links
Contact
For all support, sales, and partnership inquiries, email us at info@answerpal.eu
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerp
Belgium
+32.36416685
BE 0862.692.858