Dialpad

Creates a new SMS event subscription in the Dialpad API, allowing users to receive notifications for inbound and/or outbound SMS messages. This endpoint enables fine-grained control over SMS event monitoring, including options for filtering by direction, target, and message type. It's particularly useful for integrati…

Untrusted display-only summary

Creates a new user account in the Dialpad system with the specified details. This endpoint allows you to add a new user to your Dialpad organization, set up their basic profile information, assign them to an office, and optionally auto-assign a phone number. It's particularly useful for bulk user creation or when inte…

Untrusted display-only summary

Creates a new webhook integration for receiving real-time event notifications from Dialpad. This endpoint allows you to specify a URL where Dialpad will send event data when specific actions occur within the Dialpad system. It's essential for building responsive, event-driven integrations with Dialpad. The endpoint al…

Untrusted display-only summary

Deauthorizes (revokes) an OAuth2 access token, effectively terminating the application's access to the Dialpad API. This endpoint should be used when an application needs to invalidate its current access token, such as during user logout, when suspending an integration, or in response to potential security threats. It…

Untrusted display-only summary

Deletes a specific access control policy from the Dialpad system. This endpoint allows company administrators to remove custom permission settings that were previously created for managing user roles and access within the Dialpad platform. It should be used when a particular access control policy is no longer needed o…

Untrusted display-only summary

Deletes a specific agent status subscription identified by its unique ID. This endpoint is used to stop receiving real-time updates about an agent's status (e.g., Available, Busy, Off-duty) in the Dialpad system. It should be used when you no longer need to track the status changes for a particular agent or when clean…

Untrusted display-only summary

Deletes a specific call center from the Dialpad system. This endpoint should be used when you need to permanently remove a call center from your Dialpad account. It's important to note that this action is irreversible and will affect all associated resources, such as agents, call logs, and configurations linked to the…

Untrusted display-only summary

This endpoint deletes a specific call review share link in the Dialpad system. It's used to revoke access to a previously shared call review, ensuring that the link can no longer be used to view the associated call information. This action is permanent and should be used when you want to immediately prevent further ac…

Untrusted display-only summary

Deletes a specific call router from the Dialpad system. This endpoint should be used when you need to remove an existing call routing configuration, such as when restructuring your call flow or decommissioning outdated routing rules. The deletion is permanent and cannot be undone, so use with caution. This operation w…

Untrusted display-only summary

Deletes a specific call subscription from the Dialpad system. This endpoint should be used when an application no longer needs to receive real-time notifications for a particular call-related event or functionality. It allows developers to clean up unused subscriptions, potentially freeing up resources and reducing un…

Untrusted display-only summary

Deletes a specific channel from the Dialpad communication platform. This endpoint should be used when you need to remove a communication channel that is no longer needed or has become obsolete. It permanently removes the channel and all associated data, so it should be used with caution. This operation cannot be undon…

Untrusted display-only summary

Removes a specified member from a Dialpad channel. This endpoint allows you to delete a user from a particular channel, effectively revoking their access and participation in that channel's communications. It should be used when you need to remove a team member from a specific collaboration space, such as when an empl…

Untrusted display-only summary

Deletes a specific contact from the Dialpad system using the provided contact ID. This endpoint should be used when you need to permanently remove a contact's information from your Dialpad account. It's important to note that this action is irreversible, and once a contact is deleted, it cannot be recovered through th…

Untrusted display-only summary

Deletes a custom Interactive Voice Response (IVR) configuration from a specified target in the Dialpad system. This endpoint is used to remove IVR settings, allowing for the reset or reconfiguration of call routing and automated response systems. It's particularly useful when updating IVR workflows or when a specific…

Untrusted display-only summary

Deletes a specific department from the Dialpad system. This endpoint should be used when you need to remove a department that is no longer needed or has been deprecated within your organization's structure. The operation is irreversible, so it should be used with caution. Once a department is deleted, all associated d…

Untrusted display-only summary

Deletes a specific deskphone associated with a user in the Dialpad system. This endpoint should be used when you need to remove a deskphone from a user's account, such as when the device is no longer in use or needs to be reassigned. The operation is permanent and cannot be undone, so it should be used with caution. T…

Untrusted display-only summary

This endpoint removes a specific deskphone from a designated room within the Dialpad system. It's used to unassign or decommission a deskphone from a particular shared space, such as a conference room or reception area. The operation is permanent and should be used with caution as it will disassociate the deskphone fr…

Untrusted display-only summary

Deletes a specific phone number from the user's Dialpad account. This endpoint should be used when a phone number is no longer needed and needs to be removed from the system. It's important to note that this action is irreversible, and once a number is deleted, it may not be possible to reclaim the same number. This e…

Untrusted display-only summary

Removes a specified operator (user or room) from a particular office in the Dialpad system. This endpoint is used to manage the association between operators and offices, allowing administrators to control access and permissions within the organization's structure. It should be used when you need to disassociate a use…

Untrusted display-only summary

Removes a specified operator from a call center in the Dialpad system. This endpoint should be used when you need to disassociate an agent or user from a particular call center, such as when an employee changes roles or leaves the organization. The operation is permanent and cannot be undone through this API. If you n…

Untrusted display-only summary

Removes a specified operator from a department in the Dialpad system. This endpoint is used to update department operator assignments by removing either a user or a room from the list of operators for a given department. It's particularly useful for managing call routing and department resources. The endpoint requires…

Untrusted display-only summary

Deletes a specific recording share link in the Dialpad system. This endpoint is used to revoke access to a shared recording by removing the associated link. It should be called when you want to prevent further access to a recording through a previously generated share link. This action is permanent and cannot be undon…

Untrusted display-only summary

Deletes a specific room from the Dialpad system using its unique identifier. This endpoint should be used when you need to remove a room that is no longer in use or has been decommissioned, such as a closed conference room or a removed reception desk. The deletion is permanent and cannot be undone, so use this endpoin…

Untrusted display-only summary

Deletes a specific scheduled report from the Dialpad system. This endpoint allows users to permanently remove a previously configured report that was set up for automatic generation and delivery. It should be used when a particular scheduled report is no longer needed or when you want to stop the automatic generation…

Untrusted display-only summary

Deletes a specific SMS subscription from the Dialpad system. This endpoint should be used when you want to cancel or remove an existing SMS subscription, such as when a user no longer needs SMS services or wants to change their subscription plan. The operation is irreversible, so it should be used with caution. Once d…

Untrusted display-only summary

Deletes a specific changelog entry from a subscription in the Dialpad system. This endpoint is used to permanently remove a record of changes made to a subscription, which could include modifications to webhook configurations, event subscriptions, or other subscription-related settings. It should be used when you need…

Untrusted display-only summary

Deletes a specific subscription contact from the Dialpad system. This endpoint should be used when you need to remove a contact from your subscription list, such as when a user unsubscribes or when cleaning up outdated contact information. The operation is irreversible, so use it with caution. This endpoint only handl…

Untrusted display-only summary

Deletes a user from the Dialpad system based on the provided user ID. This endpoint should be used when permanently removing a user's account and associated data from Dialpad. It's important to note that deleted users can be restored for up to 72 hours after deletion, after which their records are anonymized. Use this…

Untrusted display-only summary

Deletes a specific webhook subscription from the Dialpad platform using its unique identifier. This endpoint should be used when you want to stop receiving real-time event notifications for a particular webhook. It's important to note that once a webhook is deleted, it cannot be recovered, and you will need to create…

Untrusted display-only summary

Closes and removes a specific WebSocket connection in the Dialpad system. This endpoint should be used when an application needs to programmatically terminate a real-time event subscription or clean up unused WebSocket connections. It's particularly useful for managing resources and ensuring that inactive or unnecessa…

Untrusted display-only summary