# Convirza

## Docs
- [Choosing the Right API Version](https://docs.convirza.com/choosing-the-right-api-version-2064948m0.md): 
- [Getting Started](https://docs.convirza.com/getting-started-2079902m0.md): 
- [Architecture](https://docs.convirza.com/architecture-2043388m0.md): 
- [Quick Start](https://docs.convirza.com/quick-start-2043383m0.md): 
- [Authentication](https://docs.convirza.com/authentication-2043390m0.md): 
- [Roles and API Access](https://docs.convirza.com/roles-and-api-access-2066692m0.md): 
- [API Categories](https://docs.convirza.com/api-categories-2043387m0.md): 
- [API Endpoints Reference](https://docs.convirza.com/api-endpoints-reference-2043386m0.md): 
- [Making Your First API Call](https://docs.convirza.com/making-your-first-api-call-2043380m0.md): 
- [Working with Encrypted Tokens](https://docs.convirza.com/working-with-encrypted-tokens-2043382m0.md): 
- [Code Examples](https://docs.convirza.com/code-examples-2043384m0.md): 
- [Error Handling](https://docs.convirza.com/error-handling-2043381m0.md): 
- [Best Practices](https://docs.convirza.com/best-practices-2043404m0.md): 
- [Troubleshooting](https://docs.convirza.com/troubleshooting-2043389m0.md): 
- [Support](https://docs.convirza.com/support-2043385m0.md): 

## API Docs
- [Get Access Token](https://docs.convirza.com/get-access-token-32391152e0.md): Authenticates user credentials and returns access and refresh tokens for API access.
- [Get Access Token](https://docs.convirza.com/get-access-token-31635276e0.md): Authenticates a user's email and password and returns a token pair for use with all other Convirza API endpoints.
- [Refresh Access Token](https://docs.convirza.com/refresh-access-token-32380342e0.md): Exchanges a valid refresh token for a new access token and refresh token pair, extending the user's session without requiring them to re-enter their password.
- [Revoke Token](https://docs.convirza.com/revoke-token-32380343e0.md): Immediately invalidates a specific access or refresh token by removing its Redis session entry. The token becomes unusable within milliseconds — there is no grace period.
- User [List Reports](https://docs.convirza.com/list-reports-31749889e0.md): Retrieves available reports based on the authenticated user's permissions and access level. Returns report metadata including IDs, names, and admin restrictions. Supports pagination and filtering.
- Scorecard [List Scorecards](https://docs.convirza.com/list-scorecards-31749890e0.md): Retrieves scorecards accessible to the authenticated user based on organizational access permissions. Returns scorecard metadata including names, IDs, group access settings, creation details, and importance levels. Supports pagination and filtering.
- Scorecard [List Scored Calls Report](https://docs.convirza.com/list-scored-calls-report-31749891e0.md): Generates a comprehensive report of scored call data, including outcome percentages compared to average scores and detailed criteria performance metrics. Used for quality assurance and performance evaluation. Supports pagination and filtering.
- Scorecard [Add or Update Call Title](https://docs.convirza.com/add-or-update-call-title-31749892e0.md): Assigns or updates a custom title for a call record. Used to add descriptive labels to calls for easier identification and organization within scorecards.
- Scorecard [Create Scorecard](https://docs.convirza.com/create-scorecard-31749893e0.md): Create scorecard record with given parameters
- Scorecard [Duplicate Scorecard](https://docs.convirza.com/duplicate-scorecard-31749894e0.md): Duplicate a scorecard by providing its ID and any fields to update
- Scorecard [Archive Scorecard](https://docs.convirza.com/archive-scorecard-31749895e0.md): Archive a scorecard by providing its ID
- Call [Get Call Record by ID](https://docs.convirza.com/get-call-record-by-id-31749896e0.md): Retrieves detailed information for a specific call record by ID. Returns complete call metadata including duration, caller information, routing details, disposition, and associated campaign data.
- Call [List Calls](https://docs.convirza.com/list-calls-31749897e0.md): Retrieves call records matching specified filter criteria. Returns basic call information suitable for list views and reporting. Supports pagination, filtering by date range, campaign, group, caller ID, and other attributes.
- Call [List Call Details](https://docs.convirza.com/list-call-details-31749898e0.md): Retrieves call records with extended detail fields beyond the basic call list. Returns comprehensive call data including duration, cost, routing path, recording URLs, transcription data, custom fields, tags, and campaign information. Supports pagination and advanced filtering.
- Call [List Archived Call Details](https://docs.convirza.com/list-archived-call-details-31749899e0.md): Retrieves call records from long-term archived storage for calls older than two and a half years. Returns the same detailed information as the standard call detail endpoint but accesses historical data beyond the active retention period. Supports pagination and filtering.
- Call [List Call Details](https://docs.convirza.com/list-call-details-31749900e0.md): Retrieves call records with additional extended fields and analytics data beyond standard call details. Returns enhanced call information including advanced metrics, conversation intelligence data, and enriched routing information. Supports pagination and filtering.
- Call [List Calls With Transcription](https://docs.convirza.com/list-calls-with-transcription-31749901e0.md): Retrieves call records that have associated transcriptions. Returns call metadata along with transcription text generated from call recordings. Useful for text-based call analysis and keyword searching. Supports pagination and filtering.
- Call [List Calls With Transcription Details](https://docs.convirza.com/list-calls-with-transcription-details-31749902e0.md): Retrieves call records with detailed transcription data including timestamps, speaker identification, and confidence scores. Returns comprehensive transcription metadata beyond basic text. Supports pagination and filtering.
- Call [List Calls With Tags](https://docs.convirza.com/list-calls-with-tags-31749903e0.md): Retrieves call records with associated tags. Returns call metadata including all tags assigned to each call for categorization and filtering purposes. Supports pagination and filtering.
- Call [Add Tags To Call](https://docs.convirza.com/add-tags-to-call-31749904e0.md): Assigns one or more tags to a specific call record for categorization and organization. Tags enable easier filtering and grouping of calls based on custom criteria.
- Call [List Calls With Custom Sources](https://docs.convirza.com/list-calls-with-custom-sources-31749905e0.md): Retrieves call records with custom source attribution data. Returns calls along with their associated custom marketing source parameters used for campaign tracking and attribution analysis. Supports pagination and filtering.
- Call [List Calls With Indicator Scores](https://docs.convirza.com/list-calls-with-indicator-scores-31749906e0.md): Retrieves call records with conversation intelligence indicator scores. Returns calls along with AI-generated scores for metrics such as sentiment, call quality, and outcome probability. Supports pagination and filtering.
- Call [List Calls With DNI](https://docs.convirza.com/list-calls-with-dni-31749907e0.md): Retrieves call records with Dynamic Number Insertion (DNI) web tracking data. Returns calls along with associated visitor session information including browser details, IP addresses, referrer URLs, landing pages, and other web analytics for marketing attribution. Supports pagination and filtering.
- Call [List Call Metrics by Group](https://docs.convirza.com/list-call-metrics-by-group-31749908e0.md): Retrieves aggregated call metrics grouped by organizational units. Returns call volume statistics, performance indicators, and analytics rolled up by group hierarchy. Useful for management reporting and cross-team comparisons. Supports pagination and filtering.
- Call [List Call Metrics Details by Group](https://docs.convirza.com/list-call-metrics-details-by-group-31749909e0.md): Retrieves detailed aggregated call metrics grouped by organizational units with additional granular breakdowns. Returns comprehensive call statistics, performance indicators, and analytics with more detail than the standard group activity endpoint. Supports pagination and filtering.
- Call [Upload Call Audio](https://docs.convirza.com/upload-call-audio-31749910e0.md): Uploads a call audio recording file and creates a corresponding call detail record in the system. Accepts either a direct file upload or a URL to an audio file. Supports mp3 and wav formats. Used for importing external call recordings into Convirza for analysis and transcription.
- Call [Get Call Record by ID](https://docs.convirza.com/get-call-record-by-id-31749911e0.md): Retrieves a specific call record formatted for webhook delivery. Returns call data in a structure optimized for webhook integrations and real-time event notifications to external systems.
- Call [Add Comment To Call](https://docs.convirza.com/add-comment-to-call-31749912e0.md): Adds one or more comments to a call record for note-taking and collaboration. Comments are visible to users with access to the call and support multi-user annotations.
- Call [Move Call To Group](https://docs.convirza.com/move-call-to-group-31749913e0.md): Transfers a call record from one organizational group to another within the same account. Used for reorganizing call data and correcting misrouted call assignments.
- Blacklist [List Blacklisted Numbers](https://docs.convirza.com/list-blacklisted-numbers-31749914e0.md): Retrieves phone numbers blacklisted within the user's organizational hierarchy. Returns blacklisted numbers from the current group and all child groups. Supports pagination and filtering by phone number patterns.
- Blacklist [Add Number To Blacklist](https://docs.convirza.com/add-number-to-blacklist-31749915e0.md): Adds one or more phone numbers to the blacklist to prevent them from reaching your organization. Blacklisted callers will be automatically blocked from connecting.
- Blacklist [Delete Blacklisted Numbers](https://docs.convirza.com/delete-blacklisted-numbers-31749916e0.md): Removes one or more phone numbers from the blacklist, allowing them to reach your organization again.
- Call Action [Create Call Actions](https://docs.convirza.com/create-call-actions-31749917e0.md): Creates call action rules that automatically trigger actions based on call criteria. Call actions enable automated workflows such as sending notifications, tagging calls, or triggering integrations when specific conditions are met.
- Call Action [Update Call Action](https://docs.convirza.com/update-call-action-31749918e0.md): Updates an existing call action rule configuration. Allows modification of trigger conditions and associated actions for automated call workflows.
- Email [Send Call Data Email](https://docs.convirza.com/send-call-data-email-31749919e0.md): Sends call data via email for a specific call record. Retrieves call details by ID and delivers them to specified email recipients in the requested format.
- SMS [Send SMS](https://docs.convirza.com/send-sms-31749920e0.md): Sends an SMS message from the first SMS-enabled tracking number associated with a specified campaign. Used for outbound text messaging to customers via campaign tracking numbers.
- SMS [List SMS Conversations](https://docs.convirza.com/list-sms-conversations-31749921e0.md): Retrieves SMS conversation threads including message history between tracking numbers and contacts. Returns conversations with message content, timestamps, participant information, and delivery status. Supports pagination and filtering.
- Webhook [List Webhooks](https://docs.convirza.com/list-webhooks-31749922e0.md): Retrieves webhook configurations for a specific organizational unit. Returns webhook endpoint URLs, trigger events, authentication settings, and delivery status. Supports pagination and filtering.
- Webhook [Create Webhook](https://docs.convirza.com/create-webhook-31749923e0.md): Creates a new webhook configuration for receiving real-time event notifications. Webhooks enable integration with external systems by sending HTTP requests when specified events occur.
- Webhook [Update Webhook](https://docs.convirza.com/update-webhook-31749924e0.md): Updates an existing webhook configuration. Allows modification of endpoint URL, trigger events, authentication settings, and delivery preferences.
- Campaign [Get Campaign by ID](https://docs.convirza.com/get-campaign-by-id-31749925e0.md): Retrieves detailed configuration for a specific campaign by ID. Returns campaign settings including tracking numbers, routing rules, business hours, geographic targeting, and performance analytics configuration.
- Campaign [Create Campaign](https://docs.convirza.com/create-campaign-31749926e0.md): Creates one or more new campaign records. Campaigns organize call tracking by marketing initiative, allowing you to track performance across different advertising channels and sources.
- Campaign [Delete Campaign](https://docs.convirza.com/delete-campaign-31749927e0.md): Deletes a specific campaign by ID. Optionally supports forced deletion to remove campaigns with associated data.
- Campaign [List Campaigns](https://docs.convirza.com/list-campaigns-31749928e0.md): Retrieves campaigns accessible within the user's organizational hierarchy. Returns campaign metadata including names, status, tracking numbers, and routing configurations. Supports pagination and filtering.
- Campaign [List Campaigns With Users](https://docs.convirza.com/list-campaigns-with-users-31749929e0.md): Retrieves campaigns with associated user assignments. Returns campaign data showing which users have access to each campaign for permission management and reporting scope configuration. Supports pagination and filtering.
- Campaign [Add Users To Campaign](https://docs.convirza.com/add-users-to-campaign-31749930e0.md): Assigns users to campaigns or updates existing user-campaign associations. Controls which users have access to view and manage specific campaigns.
- Campaign [List Campaigns With Call Flows](https://docs.convirza.com/list-campaigns-with-call-flows-31749931e0.md): Retrieves campaigns with their associated call flow routing configurations. Returns campaign data including linked call flows for understanding routing relationships. Supports pagination and filtering.
- Call Flow [Get Call Flow by ID](https://docs.convirza.com/get-call-flow-by-id-31749932e0.md): Retrieves detailed routing configuration for a specific call flow by ID. Returns the complete call flow definition including routing logic, business hours, hunt groups, IVR menus, voicemail settings, and call handling options.
- Call Flow [Create Call Flows](https://docs.convirza.com/create-call-flows-31749933e0.md): Creates or updates call flow routing configurations. Provisions phone numbers with routing rules including forwarding destinations, business hours, IVR menus, and call handling logic.
- Call Flow [Delete Call Flow](https://docs.convirza.com/delete-call-flow-31749934e0.md): Deletes a specific call flow routing configuration by ID. Removes the call flow and its associated routing rules.
- Call Flow [List Call Flows by Campaign](https://docs.convirza.com/list-call-flows-by-campaign-31749935e0.md): Retrieves detailed information about a specific campaign configuration. Returns campaign settings including tracking numbers, routing rules, business hours, geographic targeting, conversion tracking, and performance analytics configuration.
- Call Flow [List Call Flows](https://docs.convirza.com/list-call-flows-31749936e0.md): Retrieves call flows accessible within the user's organizational hierarchy. Returns call flow metadata including names, associated campaigns, routing types, and status. Supports pagination and filtering.
- Call Flow [List Deleted Call Flows](https://docs.convirza.com/list-deleted-call-flows-31749937e0.md): Retrieves previously deleted call flows for audit and recovery purposes. Returns call flow records that have been marked as deleted but remain in the system for historical tracking. Supports pagination and filtering.
- Call Flow [List Call Flows With Routes](https://docs.convirza.com/list-call-flows-with-routes-31749938e0.md): Retrieves call flows with complete routing information and path details. Returns comprehensive routing configurations including hunt sequences, failover paths, and forwarding rules. Supports pagination and filtering.
- Call Flow [List Call Flows With Location](https://docs.convirza.com/list-call-flows-with-location-31749939e0.md): Retrieves call flows with geographic location and geo-routing information. Returns call flow configurations along with location-based routing rules that direct calls based on caller geography. Supports pagination and filtering.
- Call Flow [List Call Flows With Numbers](https://docs.convirza.com/list-call-flows-with-numbers-31749940e0.md): Retrieves call flows with assigned tracking phone numbers and number pool information. Returns call flow configurations along with associated phone numbers and custom source settings for each number. Supports pagination and filtering.
- Call Flow [List Call Flows With Recording](https://docs.convirza.com/list-call-flows-with-recording-31749941e0.md): Retrieves call flows with call recording settings and preferences. Returns call flow configurations along with recording enablement status, storage options, and compliance settings. Supports pagination and filtering.
- Call Flow [List Call Flows With Actions](https://docs.convirza.com/list-call-flows-with-actions-31749942e0.md): Retrieves call flows with associated call action automation rules. Returns call flow configurations along with automated action triggers and workflows configured for each flow. Supports pagination and filtering.
- Call Flow [List Call Flows With DNI](https://docs.convirza.com/list-call-flows-with-dni-31749943e0.md): Retrieves call flows configured with Dynamic Number Insertion (DNI) for web visitor tracking. Returns call flow configurations along with DNI settings, number pools, and web integration parameters used for marketing attribution. Supports pagination and filtering.
- Call Flow [Create Call Flow DNI Settings](https://docs.convirza.com/create-call-flow-dni-settings-31749944e0.md): Creates Dynamic Number Insertion settings for call flows to enable web visitor-level call tracking. Configures number pools and insertion parameters that dynamically display different tracking numbers to website visitors based on their session.
- Call Flow [List DNI Classes With Call Flow](https://docs.convirza.com/list-dni-classes-with-call-flow-31749945e0.md): Retrieves DNI classes with associated call flow assignments. Returns DNI class configurations showing which call flows use each class for number pool management and visitor tracking segmentation.
- Call Flow [List Call Flow Custom Sources](https://docs.convirza.com/list-call-flow-custom-sources-31749946e0.md): Retrieves custom marketing sources configured for call flow tracking. Returns custom source definitions used for campaign attribution and marketing channel tracking. Supports pagination and filtering.
- Call Flow [Create Call Flow Custom Source](https://docs.convirza.com/create-call-flow-custom-source-31749947e0.md): Creates custom marketing source parameters for call flow tracking and attribution. Custom sources enable tracking of specific marketing channels, campaigns, or referral sources for performance analysis.
- Call Flow [Delete Call Flow Custom Source](https://docs.convirza.com/delete-call-flow-custom-source-31749948e0.md): Removes custom source configurations from a call flow, disabling tracking for those marketing parameters.
- Call Flow [Create Call Flows With Multilevel IVR](https://docs.convirza.com/create-call-flows-with-multilevel-ivr-31749949e0.md): Creates call flows with multi-level IVR (Interactive Voice Response) menu systems. Configures hierarchical phone menus with multiple levels of options for advanced call routing and self-service workflows.
- Call Flow [Create Call Flow Outbound](https://docs.convirza.com/create-call-flow-outbound-31749950e0.md): Creates outbound call flow configurations for making outbound calls through the system. Configures routing rules, caller ID settings, and call handling for calls originated by your organization rather than received.
- Call Flow [List Call Flows With Count](https://docs.convirza.com/list-call-flows-with-count-31749951e0.md): Retrieves call flows with routing information along with total count metrics. Returns call flow configurations with routing details plus pagination metadata including total records. Supports filtering.
- Call Flow [Remove Number From Route Pool](https://docs.convirza.com/remove-number-from-route-pool-31749952e0.md): Removes phone numbers from a provisioned route pool after validation. Deletes specified numbers from the pool, making them unavailable for dynamic assignment. Validates number existence before removal.
- Group [List Groups](https://docs.convirza.com/list-groups-31749953e0.md): Retrieves detailed information for a specific organizational group by ID. Returns group configuration including hierarchy position, settings, permissions, and associated resources.
- Group [Create Group](https://docs.convirza.com/create-group-31749954e0.md): Creates new organizational groups or updates existing group configurations in bulk. Groups organize users, campaigns, and call flows in a hierarchical structure for permissions and reporting.
- Group [List Groups With Users](https://docs.convirza.com/list-groups-with-users-31749955e0.md): Retrieves organizational groups with associated user information. Returns groups accessible to the authenticated user along with user assignments for each group. Supports pagination and filtering.
- Group [List Groups With Users](https://docs.convirza.com/list-groups-with-users-31749956e0.md): Retrieves organizational groups with detailed user membership information. Returns groups along with complete user data for members of each group including roles and permissions. Supports pagination and filtering.
- Group [Create User in Group](https://docs.convirza.com/create-user-in-group-31749957e0.md): Creates new users within a specified organizational group. Provisions user accounts with credentials, roles, and group membership in a single operation.
- Group [Update Group User](https://docs.convirza.com/update-group-user-31749958e0.md): Updates existing user information including profile details, permissions, and group assignments. Requires user ID or agent ID to identify the user to modify.
- Group [Get DNI Snippet](https://docs.convirza.com/get-dni-snippet-31749959e0.md): Retrieves the DNI JavaScript snippet code for a specific group. Returns the snippet that should be embedded in websites to enable Dynamic Number Insertion for visitor-level call tracking.
- Group [List Active Call Flows](https://docs.convirza.com/list-active-call-flows-31749960e0.md): Retrieves active call flows for a group showing essential routing information. Returns simplified call flow data including tracking numbers, ring-to numbers, and whisper settings for quick reference. Supports pagination and filtering.
- Group [List Group Call Logs](https://docs.convirza.com/list-group-call-logs-31749961e0.md): Retrieves call log records for a specific group. Returns call history including timestamps, participants, duration, and outcomes for audit and reporting purposes. Supports pagination and filtering.
- Number [Search Phone Numbers](https://docs.convirza.com/search-phone-numbers-31749962e0.md): Searches available phone numbers from carrier inventory based on area code, prefix, pattern, or geographic location. Returns available numbers that can be reserved and provisioned. Numbers showing null number_id are carrier-available and require reservation before provisioning. See the Knowledge Base article for complete workflow instructions.
- Number [Search Reserved Numbers](https://docs.convirza.com/search-reserved-numbers-31749963e0.md): Searches phone numbers that have been reserved for your organization but not yet provisioned. Returns numbers from your private reserved inventory that are ready to be assigned to call flows. Supports filtering by area code, prefix, or pattern.
- Number [Reserve Phone Number](https://docs.convirza.com/reserve-phone-number-31749964e0.md): Reserves phone numbers from carrier inventory into your private pool. Reserved numbers become exclusively available to your organization and can be provisioned to call flows. Use after searching carrier inventory to secure desired numbers.
- Miscellaneous [List Geo Locations](https://docs.convirza.com/list-geo-locations-31749965e0.md): Retrieves configured geo-routing locations for geographic call routing. Returns location records that define routing rules based on caller geography. Supports pagination and filtering.
- Miscellaneous [List Locations](https://docs.convirza.com/list-locations-31749966e0.md): Retrieves detailed location information for a specific geo-routing location by ID. Returns the complete location configuration including geographic boundaries and routing rules.
- Miscellaneous [Add Locations](https://docs.convirza.com/add-locations-31749967e0.md): Creates a new geo-routing location or updates an existing location configuration. Geo-routing locations define geographic areas and associated routing rules for location-based call handling.
- Miscellaneous [Add Locations](https://docs.convirza.com/add-locations-31749968e0.md): Adds or updates new locations to a Geolocations list with reference to location id in batches. Batches are limited to 100 locations.
- Miscellaneous [List Audio Files](https://docs.convirza.com/list-audio-files-31749969e0.md): Retrieves a paginated list of of audio (whisper/prompt) uploaded by the logged in user for groups/sub groups with filtering and search capabilities. Returns detailed of audio (whisper/prompt) uploaded by the logged in user for groups/sub groups data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- Miscellaneous [Upload Whisper Audio](https://docs.convirza.com/upload-whisper-audio-31749970e0.md): 
- Miscellaneous [Upload Prompt Audio](https://docs.convirza.com/upload-prompt-audio-31749971e0.md): 
- Miscellaneous [List Channels](https://docs.convirza.com/list-channels-31749972e0.md): Retrieves a paginated list of of all available channels with description and details of each with filtering and search capabilities. Returns detailed of all available channels with description and details of each data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- Miscellaneous [List Rate Centers](https://docs.convirza.com/list-rate-centers-31749973e0.md): Retrieves a paginated list of of all available telcom rate centers for the specified state with filtering and search capabilities. Returns detailed of all available telcom rate centers for the specified state data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- Miscellaneous [List Scheduled Reports](https://docs.convirza.com/list-scheduled-reports-31749974e0.md): Retrieves a paginated list of of scheduled report with filtering and search capabilities. Returns detailed of scheduled report data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- Miscellaneous [Get Subscription](https://docs.convirza.com/get-subscription-31749975e0.md): Returns information about your subscription
- Custom Source [Get Custom Sources by Group](https://docs.convirza.com/get-custom-sources-by-group-31749976e0.md): Returns a list of custom sources of the given matching criteria
- Custom Source [Create Custom Source](https://docs.convirza.com/create-custom-source-31749977e0.md): Create and set all the values for custom sources records
- Custom Source [Delete Custom Sources](https://docs.convirza.com/delete-custom-sources-31749978e0.md): delete custom sources
- Tag [List Tags](https://docs.convirza.com/list-tags-31749979e0.md): Retrieves a paginated list of of all tags  associated with loggedin user with filtering and search capabilities. Returns detailed of all tags  associated with loggedin user data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- Tag [Delete Tags](https://docs.convirza.com/delete-tags-31749980e0.md): Delete tags
- User Permissions [Get User Permissions](https://docs.convirza.com/get-user-permissions-31749981e0.md): Retrieves detailed information about a specific permissions for a specific user with groups. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested permissions for a specific user with groups.
- User Permissions [Update User Permissions](https://docs.convirza.com/update-user-permissions-31749982e0.md): Add/remove groups access for given ct_user_id
- User Permissions [List Allowed Groups](https://docs.convirza.com/list-allowed-groups-31749983e0.md): Get list of groups which can be allowed to have permissions
- Insights [Create Insight](https://docs.convirza.com/create-insight-31749984e0.md): Create insight record with given parameters
- SMS Broadcast [List Broadcasts](https://docs.convirza.com/list-broadcasts-31749985e0.md): Retrieves detailed information about a specific all broadcast lists for an org unit. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested all broadcast lists for an org unit.
- SMS Broadcast [Create SMS Broadcast](https://docs.convirza.com/create-sms-broadcast-31749986e0.md): Create a new SMS broadcast by selecting individual contacts or entire contact lists. Either contact_ids or contact_list_ids must be provided, but not both.
- SMS Broadcast [Update Broadcast](https://docs.convirza.com/update-broadcast-31749987e0.md): Update broadcast SMS details. Provide either contact_ids or contact_list_ids, but not both.
- SMS Broadcast [Delete Broadcast](https://docs.convirza.com/delete-broadcast-31749988e0.md): Delete broadcast schedule
- SMS Broadcast [Get Broadcast Messages](https://docs.convirza.com/get-broadcast-messages-31749989e0.md): Retrieves detailed information about a specific broadcast messages by broadcast id. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested broadcast messages by broadcast id.
- SMS Broadcast [List Contact Lists](https://docs.convirza.com/list-contact-lists-31749990e0.md): Retrieves a paginated list of contact lists with filtering and search capabilities. Returns detailed contact lists data including metadata, status information, and related attributes. Results are scoped to the authenticated user's organizational access permissions.
- SMS Broadcast [Create Contact List](https://docs.convirza.com/create-contact-list-31749991e0.md): Create a new contact list with the given parameters
- SMS Broadcast [Get Contact List](https://docs.convirza.com/get-contact-list-31749992e0.md): Retrieves detailed information about a specific contact list metadata and summary. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested contact list metadata and summary.
- SMS Broadcast [Update Contact List](https://docs.convirza.com/update-contact-list-31749993e0.md): Update the name and description of an existing contact list
- SMS Broadcast [Delete Contact List](https://docs.convirza.com/delete-contact-list-31749994e0.md): User can delete specific contact list record using contact list id
- SMS Broadcast [List Contacts in Contact List](https://docs.convirza.com/list-contacts-in-contact-list-31749995e0.md): Retrieves detailed information about a specific contacts in a contact list. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested contacts in a contact list.
- SMS Broadcast [Add Contacts To Contact List](https://docs.convirza.com/add-contacts-to-contact-list-31749996e0.md): Add multiple contact numbers to an existing contact list with validation for duplicates
- SMS Broadcast [Update Contact in Contact List](https://docs.convirza.com/update-contact-in-contact-list-31749997e0.md): Update a contact under a contact list
- SMS Broadcast [Remove Contact From List](https://docs.convirza.com/remove-contact-from-list-31749998e0.md): User can delete specific contact record using contact id
- SMS Broadcast [List Contacts](https://docs.convirza.com/list-contacts-31749999e0.md): Retrieves detailed information about a specific contacts with pagination and filtering. Returns comprehensive data including configuration details, status, associated relationships, and relevant metadata for the requested contacts with pagination and filtering.
- SMS Broadcast [Create Contacts](https://docs.convirza.com/create-contacts-31750000e0.md): Create one or more contacts with the given phone numbers and optional names
- SMS Broadcast [Update Contact](https://docs.convirza.com/update-contact-31750001e0.md): Update the phone number and name of an existing contact
- SMS Broadcast [Delete Contact](https://docs.convirza.com/delete-contact-31750002e0.md): User can delete specific contact record using contact id
- Platform > Users [List Users](https://docs.convirza.com/list-users-31381268e0.md): Returns a filtered and paginated list of users belonging to an organizational unit and all sub-units the authenticated admin has access to.
- Platform > Users [Get User Details](https://docs.convirza.com/get-user-details-31381269e0.md): Fetches the complete profile and configuration for a single user by their unique numeric ID.
- Platform > Users [Update User](https://docs.convirza.com/update-user-31381270e0.md): Performs a full update of a user record. All fields in the request body overwrite the existing values.
- Platform > Users [Partial Update User](https://docs.convirza.com/partial-update-user-31381271e0.md): Applies a partial update to a user record, modifying only the fields present in the request body. All fields not included in the payload retain their existing values.
- Platform > Users [Delete User](https://docs.convirza.com/delete-user-31381272e0.md): Soft-deletes a user by marking their account status as `deleted`. The user's data and call history are preserved in the database for audit and reporting purposes.
- Platform > Users [Create User](https://docs.convirza.com/create-user-31381273e0.md): Creates a new user account and assigns them to an organizational unit with a specified role.
- Platform > Groups [List Child Groups](https://docs.convirza.com/list-child-groups-31381257e0.md): Returns all direct child groups (sub-groups) belonging to the authenticated user's organization unit, with optional filtering by name or specific org unit ID.
- Platform > Groups [Get Group Tree](https://docs.convirza.com/get-group-tree-31381258e0.md): Returns the complete organizational hierarchy as a nested tree, scoped to the authenticated user's account access.
- Platform > Groups [Get Group Details](https://docs.convirza.com/get-group-details-31381259e0.md): Fetches details for a single organizational unit.
- Platform > Groups [List Groups](https://docs.convirza.com/list-groups-31381264e0.md): Returns the organizational unit hierarchy starting from the specified OUID.
- Platform > Groups [Get Org Unit Hierarchy](https://docs.convirza.com/get-org-unit-hierarchy-31927187e0.md): Returns the flattened list of organizational unit IDs that form the hierarchy rooted at the specified `org_unit_id`. This is the authoritative scope query — the returned IDs represent every org unit the specified group is responsible for, including itself, its immediate children (level 1), and all deeper descendants.
- Platform > Groups [Update Group](https://docs.convirza.com/update-group-31381260e0.md): Performs a full update of a group record. All fields in the request body overwrite the stored values.
- Platform > Groups [Partial Update Group](https://docs.convirza.com/partial-update-group-31381261e0.md): Applies a partial update to a group record, modifying only the fields present in the request body. All fields not included in the payload retain their existing values.
- Platform > Groups [Delete Group](https://docs.convirza.com/delete-group-31381262e0.md): Soft-deletes a group (organizational unit) by marking its status as `deleted`. The group's historical data, call records, and configuration are preserved in the database.
- Platform > Groups [Create Group](https://docs.convirza.com/create-group-31381263e0.md): Creates a new organizational unit (group) and positions it in the account hierarchy under the specified parent.
- Platform > Webhooks [List Webhooks](https://docs.convirza.com/list-webhooks-31381274e0.md): Returns a paginated list of webhook configurations for the authenticated user's organization.
- Platform > Webhooks [Get Webhook Details](https://docs.convirza.com/get-webhook-details-31381275e0.md): Fetches the complete configuration for a single webhook by its unique ID.
- Platform > Webhooks [Update Webhook](https://docs.convirza.com/update-webhook-31381276e0.md): Performs a full update of a webhook configuration. All fields in the request body overwrite the stored values.
- Platform > Webhooks [Partial Update Webhook](https://docs.convirza.com/partial-update-webhook-31381277e0.md): Applies a partial update to a webhook, modifying only the fields present in the request body.
- Platform > Webhooks [Delete Webhook](https://docs.convirza.com/delete-webhook-31381278e0.md): Permanently deactivates and soft-deletes a webhook. Event delivery to the target URL stops immediately.
- Platform > Webhooks [Create Webhook](https://docs.convirza.com/create-webhook-31381279e0.md): Creates a new outbound webhook that will deliver event notifications to a target URL whenever specified call or SMS events occur in your account.
- Platform > Media Prompts [List Prompts](https://docs.convirza.com/list-prompts-31381265e0.md): Returns all call flow recordings for authenticated user organization unit with optional type filtering.
- Platform > Media Prompts [Upload Prompt](https://docs.convirza.com/upload-prompt-31381266e0.md): Uploads an audio file for call flow recording and stores metadata in the database.
- Platform > Media Prompts [Delete Prompt](https://docs.convirza.com/delete-prompt-31381267e0.md): Soft deletes a call flow recording by marking it as inactive without removing the audio file.
- AI Voice Agents [List AI Voice Agents](https://docs.convirza.com/list-ai-voice-agents-31106392e0.md): Returns a paginated list of AI voice agents configured in the authenticated user's account.
- AI Voice Agents [Create Agent](https://docs.convirza.com/create-agent-31106393e0.md): Creates a new AI voice agent with a complete conversation configuration and optional knowledge base files.
- AI Voice Agents [Get Agent Details](https://docs.convirza.com/get-agent-details-31106394e0.md): Retrieves the complete configuration for a single AI voice agent by its unique ID.
- AI Voice Agents [Update Agent](https://docs.convirza.com/update-agent-31106395e0.md): Performs a full update of an AI voice agent's configuration. All required fields must be provided — fields omitted from the request body are reset to defaults.
- AI Voice Agents [Partial Update Agent](https://docs.convirza.com/partial-update-agent-31106396e0.md): Applies a partial update to an AI voice agent, modifying only the fields present in the request. All other settings are preserved exactly as they are.
- AI Voice Agents [Delete Agent](https://docs.convirza.com/delete-agent-31106397e0.md): Permanently deletes an AI voice agent and all of its associated data — configuration, knowledge base files, and settings.
- Phone Numbers [Assigned Numbers](https://docs.convirza.com/assigned-numbers-31106398e0.md): Returns numbers assigned (reserved) within the authenticated user organization scope.
- Phone Numbers [Provisioned Numbers](https://docs.convirza.com/provisioned-numbers-31106399e0.md): Returns numbers provisioned within the authenticated user organization scope.
- Phone Numbers [Reserved Numbers](https://docs.convirza.com/reserved-numbers-31106400e0.md): Deletes one or more reserved numbers from local inventory when they belong to the authenticated user scope.
- Phone Numbers [Phone Numbers](https://docs.convirza.com/phone-numbers-31106401e0.md): Orders one or more numbers through supported providers and reserves them in local inventory. Note: This endpoint only purchases/reserves numbers. SMS/MMS capabilities must be configured separately via SPAPI2 microservice.
- Phone Numbers [Available Numbers](https://docs.convirza.com/available-numbers-31106402e0.md): Returns currently unprovisioned numbers from inventory. `match` cannot be combined with other filters. `rc` and `state` must be supplied together.
- Provisioned Routes [List Provisioned Routes](https://docs.convirza.com/list-provisioned-routes-31106409e0.md): Retrieves a paginated, filterable list of call-routing tracking numbers associated with the authenticated account.
- Provisioned Routes [Create Provisioned Route](https://docs.convirza.com/create-provisioned-route-31106410e0.md): Creates a new call-routing tracking number with a complete, production-ready configuration.
- Provisioned Routes [Get Provisioned Route Details](https://docs.convirza.com/get-provisioned-route-details-31106411e0.md): Retrieves the complete configuration for a single provisioned route by its unique identifier.
- Provisioned Routes [Delete Provisioned Route](https://docs.convirza.com/delete-provisioned-route-31106412e0.md): Permanently deletes a call routing configuration and performs comprehensive cleanup of all associated resources.
- Provisioned Routes [Update Provisioned Route](https://docs.convirza.com/update-provisioned-route-31106413e0.md): Performs a full update of an existing provisioned route's configuration. All updatable fields must be supplied — any field omitted from the request body will be reset to its system default.
- Provisioned Routes [Partial Update Provisioned Route](https://docs.convirza.com/partial-update-provisioned-route-31106414e0.md): Applies a selective update to an existing provisioned route. Only fields included in the request body are modified — all unspecified fields retain their current values.
- SMS Broadcasts [List Broadcasts](https://docs.convirza.com/list-broadcasts-31106419e0.md): Returns a paginated list of SMS broadcasts with optional filtering.
- SMS Broadcasts [Create Broadcast](https://docs.convirza.com/create-broadcast-31106420e0.md): Creates a new SMS broadcast conversation and prepares message records for all targeted recipients.
- SMS Broadcasts [Get Broadcast Details](https://docs.convirza.com/get-broadcast-details-31106421e0.md): Fetches complete details for one broadcast by conversation ID.
- SMS Broadcasts [Update Broadcast](https://docs.convirza.com/update-broadcast-31106422e0.md): Updates the broadcast payload for an existing scheduled broadcast.
- SMS Broadcasts [Partial Update Broadcast](https://docs.convirza.com/partial-update-broadcast-31106423e0.md): Applies partial updates to selected broadcast fields without replacing the full record.
- SMS Broadcasts [Delete Broadcast](https://docs.convirza.com/delete-broadcast-31106424e0.md): Cancels a scheduled broadcast by deleting its schedule row and marking the broadcast as cancelled.
- Conversation > Calls [Get Calls List](https://docs.convirza.com/get-calls-list-31106437e0.md): Returns a paginated list of inbound and outbound calls within a specified date range, with optional filtering and enrichment via the `include` parameter.
- Conversation > Calls [Get Call By ID](https://docs.convirza.com/get-call-by-id-31927186e0.md): Returns a single call record by its ID with optional module datasets controlled by `include`.
- Conversation > SMS [Get SMS Conversations](https://docs.convirza.com/get-sms-conversations-31106438e0.md): Returns a paginated list of SMS conversations scoped to the organizational units accessible to the authenticated user.
- Miscellaneous [List Ad Sources](https://docs.convirza.com/list-ad-sources-31106639e0.md): Returns the complete list of active advertising sources (marketing channels) available for assignment to tracking numbers and campaigns.
- Miscellaneous [List Industries](https://docs.convirza.com/list-industries-31106640e0.md): Returns the global list of industry categories used to classify your organization and campaigns.
- Miscellaneous [List Tags](https://docs.convirza.com/list-tags-31927185e0.md): Returns a paginated list of call tags available within the specified organizational unit.
- Miscellaneous [Create Tag](https://docs.convirza.com/create-tag-31106642e0.md): Creates one or more call tags for an organization. Tags created here become available for agents to apply to call records.
- Miscellaneous [Update Tag](https://docs.convirza.com/update-tag-31106643e0.md): Renames an existing tag. All call records that reference the old tag name are automatically updated to the new name.
- Miscellaneous [Delete Tag](https://docs.convirza.com/delete-tag-31106645e0.md): Soft-deletes one or more call tags by marking them as inactive. Deleted tags no longer appear in tag selectors or lists.