Connect TextIt to Dialpad

Both apps 124TextIt 14Dialpad 110

• Trigger
  New contact

  Triggers when a new contact is added to your TextIt workspace, optionally only contacts in a chosen group.

• Trigger
  New message

  Triggers when a new message is sent or received in your TextIt workspace, optionally limited to a folder or label.

• Action
  Add broadcast

  Creates and sends a new message broadcast to contacts, phone numbers/URNs or contact groups.

• Action
  Add contact

  Creates a new contact in your TextIt workspace with a name, language, URNs (phone, email, etc.), groups and contact field values.

• Action
  Add contact field

  Creates a new custom contact field in your TextIt workspace.

• Action
  Add group

  Creates a new contact group in your TextIt workspace.

• Action
  Delete contact

  Deletes a contact, identified by its UUID or one of its URNs.

• Action
  Find contacts

  Finds contacts by UUID, URN, group or modification date and returns the matching contacts.

• Action
  Find messages

  Returns messages in your TextIt workspace, filtered by message, folder, label or creation date, most recent first.

• Action
  List broadcasts

  Returns the broadcasts sent from your TextIt workspace, most recent first, optionally filtered by broadcast id or creation date.

• Action
  List contact fields

  Returns the custom contact fields defined in your TextIt workspace, with each field's key, name and data type.

• Action
  Perform contact action

  Performs a bulk action on up to 100 contacts: add to or remove from a group, block, unblock, interrupt active flow runs, or permanently delete.

• Action
  Start Flow

  Starts contacts, groups or URNs down a TextIt flow and returns the created flow start.

• Action
  Update contact

  Updates an existing TextIt contact, identified by its UUID or one of its URNs. Only the values you fill in are changed.

• Action
  Add Blocked Phone Numbers

  Adds specified phone numbers to the blocked list in dialpad. this endpoint allows users to block unwanted or spam numbers, preventing incoming calls or messages from these numbers. it accepts a list of e.164 formatted phone numbers and adds them to the user's blocked list. this tool should be used when there's a need to block multiple phone numbers at once, enhancing the platform's call and message filtering capabilities. it's particularly useful for maintaining communication hygiene and reducing unwanted interactions. note that this operation is additive; it doesn't replace the existing blocked list but appends to it.

• Action
  Add Department Operator By Id

  Adds a new operator to a specific department in dialpad. this endpoint allows you to assign either a user or a room as an operator, with the option to specify their role. it's used to manage call handling and department operations by adding new operators or updating existing ones with different roles. the department id is specified in the url path. use this when setting up new departments, expanding existing ones, or adjusting operator assignments and roles within a department.

• Action
  Add Member To Channel

  Adds a new member to a specified channel within the dialpad communication platform. this endpoint allows you to expand the membership of a channel by providing the user id of the person you want to add. it's particularly useful for programmatically managing channel memberships, such as when onboarding new team members or reorganizing communication structures. the endpoint should be used when you need to include a user in a channel's conversations and collaborations. note that this operation only adds the user to the channel; it does not create new users or channels. ensure that both the channel id (specified in the url) and the user id (provided in the request body) exist in your dialpad organization before making this call.

• Action
  Create Agent Status Subscription

  Creates or updates an agent status subscription for real-time monitoring of contact center agent statuses in dialpad. this endpoint allows you to configure event notifications for changes in agent availability, such as when agents become available, busy, or go off-duty. use this when setting up integrations that require up-to-date information on agent statuses for workforce management, real-time dashboards, or automated workflows. the subscription can be associated with a specific webhook or websocket endpoint for receiving the status updates. note that this endpoint only configures the subscription; you need to separately set up the webhook or websocket to receive the actual event data.

• Action
  Create Channel Endpoint

  Creates a new communication channel within the dialpad platform. this endpoint allows users to set up a dedicated space for team collaboration, discussions, or topic-specific conversations. it's particularly useful for organizing communication within a company or project. the created channel can be either public or private, providing flexibility in managing access and information sharing. use this endpoint when you need to programmatically create channels for various teams, projects, or departments, streamlining the process of setting up communication structures within dialpad.

• Action
  Create Custom Ivr With Audio File

  Creates a new custom interactive voice response (ivr) system within the dialpad platform. this endpoint allows you to define and configure an ivr workflow by specifying its type, associated audio file, and target assignment. use this when setting up automated phone menus, call routing systems, or customized voice interactions for different parts of your dialpad organization. the ivr can be assigned to various entities like call centers, departments, or individual users, providing flexibility in managing call flows and customer interactions.

• Action
  Create New Contact Entry

  The createcontact endpoint adds a new contact to dialpad's system. use it to create local or shared contacts with comprehensive information. ideal for user onboarding, data migration, or system integrations. supports various contact details, with some fields restricted to single-line entries for consistency.

• Action
  Create New Department Record

  Creates a new department within the dialpad system with customizable settings for call handling, operating hours, and advanced features. this endpoint allows for detailed configuration of department properties, including automatic call recording, hold queue management, custom operating hours, call routing strategies, and voice intelligence settings. it's particularly useful for setting up complex call flow structures within an organization, enabling efficient call distribution and management. the endpoint requires specifying the department name and associated office id, with numerous optional parameters for fine-tuning department behavior. it's important to note that some default values are applied if optional parameters are not provided, ensuring a functional department setup even with minimal configuration.

• Action
  Create Room In Office Via Post

  Creates a new room within a specified office in the dialpad system. this endpoint is used to set up physical or virtual spaces for collaboration, meetings, or other communication purposes. it allows you to define a room with a name and associate it with a specific office. this is particularly useful for organizations managing multiple locations or wanting to organize their communication spaces efficiently. the created room can then be used for various purposes such as scheduling meetings, assigning resources, or managing call routing within the dialpad platform.

• Action
  Create Schedule Reports Endpoint

  Creates a scheduled report in the dialpad system for various types of communication data. this endpoint allows users to automate the generation and delivery of reports on a regular basis, such as call logs, user statistics, or voicemails. it's particularly useful for managers, administrators, and analysts who need consistent, periodic insights into communication patterns and performance metrics. the endpoint offers flexible scheduling options, including daily, weekly, or monthly frequencies, and can target specific organizational units or user groups. use this when you need to set up recurring reports for monitoring, compliance, or analytical purposes. note that this endpoint creates a new schedule; to modify existing schedules, use the appropriate update endpoint.

• Action
  Create Sms Event Subscription

  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 integrating real-time sms notifications into external systems or applications. the subscription can be configured to include or exclude internal company messages and to provide updates on message delivery statuses. use this endpoint when setting up new sms monitoring systems or when adjusting existing subscription parameters.

• Action
  Create User With Auto Assign

  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 integrating dialpad user management with other systems. the endpoint requires at minimum an email and office id, with options to further customize the user's profile and permissions through additional parameters. note that while a license can be specified, it defaults to 'talk' if not provided, ensuring that the new user has basic dialpad functionality.

• Action
  Create Webhook Post Endpoint

  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 also supports an optional secret for verifying the authenticity of incoming webhook requests, enhancing security. use this when you need to set up automated workflows or sync dialpad events with external systems.

• Action
  Delete Agent Status By Id

  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 cleaning up unused subscriptions. the operation is irreversible, so care should be taken to ensure the correct subscription id is provided. this endpoint does not return the deleted subscription details; it typically returns a success status code upon successful deletion.

• Action
  Delete Call Subscription By Id

  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 unnecessary data processing. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that this operation only affects the specified subscription and does not impact any other active subscriptions or ongoing calls.

• Action
  Delete Channel By Id

  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 undone, and once a channel is deleted, it cannot be recovered. the endpoint is useful for maintaining a clean and organized communication structure within your dialpad account.

• Action
  Delete Channel Member By Id

  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 employee changes roles or leaves the organization. the endpoint requires the channel id (specified in the url path) and the user id of the member to be removed. note that this action is irreversible, and the removed member will lose access to the channel's history and future communications. it's important to ensure you have the necessary permissions to remove members before using this endpoint.

• Action
  Delete Contact By Id

  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 the api. use this endpoint with caution, ensuring that you have verified the correct contact id before deletion. this operation affects both shared company contacts and user-specific local contacts, depending on the scope of the provided id.

• Action
  Delete Department Resource

  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 data, such as user assignments and resource allocations, may be affected. this endpoint is particularly useful for maintaining an up-to-date organizational structure in dialpad, especially during restructuring or when cleaning up obsolete departments.

• Action
  Delete Operator From Department

  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 both the operator's unique id and type (user or room) to ensure accurate removal. use this when reorganizing department structures, changing operator assignments, or updating call handling workflows. note that this action is irreversible and may affect ongoing call routing for the department.

• Action
  Delete Room By Id

  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 endpoint with caution. it's important to note that deleting a room will also remove any associated configurations, such as room phone settings or extensions. this operation is part of dialpad's room management functionality and helps maintain an up-to-date inventory of active rooms in your organization.

• Action
  Delete Schedule Report By Id

  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 of a specific report. this operation cannot be undone, so it should be used with caution. the endpoint will not provide any information about the deleted report; it will only confirm the successful deletion or return an error if the operation fails.

• Action
  Delete Sms Subscription By Id

  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 deleted, the subscription and its associated settings will no longer be available. this endpoint only handles the deletion process and does not provide any information about the subscription being deleted. it's important to ensure that you have the correct subscription id before making this call, as there is no way to recover a mistakenly deleted subscription.

• Action
  Delete Subscription Changelog By Id

  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 to clean up or remove outdated or erroneous changelog entries. be cautious when using this endpoint, as deleting changelog entries may affect auditing and tracking capabilities. note that this operation is irreversible, and once a changelog entry is deleted, it cannot be recovered. this endpoint is part of dialpad's subscription management api and helps maintain an accurate and up-to-date record of subscription changes.

• Action
  Delete Subscription Contact By Id

  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 handles the deletion process and does not return the deleted contact's information. it's important to note that this action may affect any ongoing subscriptions or notifications associated with the deleted contact.

• Action
  Delete User By Id

  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 endpoint with caution as it will remove the user's access to dialpad services and may affect team structures or ongoing communications. this operation cannot be undone after the 72-hour restoration period.

• Action
  Delete Webhook By Id

  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 a new webhook subscription if you wish to receive events again. this operation is useful for managing webhook subscriptions, especially when cleaning up outdated or unnecessary event listeners in your integration with dialpad.

• Action
  Delete Websocket Connection By Id

  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 unnecessary websocket connections are properly closed. this operation is irreversible, so it should be used with caution. once a websocket is deleted, any active subscriptions or real-time data streams associated with it will be immediately terminated.

• Action
  Fetch Custom Ivrs

  Retrieves a list of all custom interactive voice response (ivr) configurations associated with the authenticated dialpad account. this endpoint allows developers to fetch comprehensive details about the custom ivrs set up in their dialpad system, including menu structures, voice prompts, and routing rules. it's particularly useful for auditing existing ivr setups, gathering information for reporting purposes, or syncing ivr configurations with external systems. the endpoint returns all custom ivrs by default, without requiring any parameters. however, it does not provide real-time analytics or call logs related to these ivrs. use this endpoint when you need an overview of your ivr landscape or when preparing to make bulk updates to your ivr configurations.

• Action
  Fetch Operators For Office Id

  Retrieves a list of operators associated with a specific office in dialpad. this endpoint should be used when you need to get information about the operators managing calls and operations within a particular office. it's useful for auditing office structure, managing call center operations, or gathering data for reporting purposes. the endpoint returns details about the operators, which may include their names, ids, roles, and current statuses. note that this endpoint only provides information about operators and does not allow for modifying operator data or office structure.

• Action
  Fetch Scheduled Reports

  Retrieves a list of scheduled reports from the dialpad system. this endpoint allows users to fetch information about reports that have been set up for automatic generation on a regular basis. it's particularly useful for administrators or users who need to review or manage the scheduled reporting configuration within their dialpad account. the endpoint supports filtering by report type, frequency, and date range, making it easy to find specific scheduled reports. it should be used when there's a need to audit existing report schedules, verify report configurations, or gather information about automated reporting processes in place. note that this endpoint only provides metadata about the scheduled reports, not the actual report content itself. it's ideal for getting an overview of reporting activities but not for accessing the report data directly.

• Action
  Fetch User Details By Id

  Retrieves detailed information about a specific user in the dialpad system. this endpoint is used to fetch comprehensive user data, including profile details, account settings, and associated communication information. it's particularly useful for user management tasks, such as verifying user information, updating records in external systems, or displaying user profiles in integrated applications. the endpoint returns a single user object based on the provided user id. it should be used when detailed information about a particular user is needed, but it will not provide aggregate data or information about multiple users simultaneously. note that the specific fields returned may depend on the requester's permissions and the user's privacy settings.

• Action
  Format Phone Numbers

  The format phone number endpoint is used to standardize and format phone numbers within the dialpad ecosystem. this tool takes a raw phone number input and converts it into a specified or default format, ensuring consistency across the platform. it's particularly useful when integrating new contact information, preparing numbers for display, or standardizing data for call routing purposes. the endpoint supports various input formats and can adapt to different country-specific number structures, making it versatile for international use. however, it's important to note that this tool is for formatting purposes only and does not validate the existence or operability of the phone number.

• Action
  Get Available Licenses For An Office

  Retrieves the number of available (unused) licenses for a specific office within a dialpad organization. this endpoint is used to check the current license capacity and availability before assigning new licenses to users or features. it provides essential information for office administrators to manage their license inventory effectively. the endpoint should be used when planning user onboarding, upgrading subscriptions, or performing license audits. note that this endpoint only returns information about unassigned licenses and does not provide details about currently assigned licenses or their usage.

• Action
  Get Call Labels

  Retrieves a list of all available call labels in the dialpad system. this endpoint allows users to fetch the current set of labels that can be applied to calls for categorization and management purposes. it's particularly useful for applications that need to display or use the full range of call labeling options in their interface or logic. the endpoint returns a collection of call labels, likely including their names and any associated metadata. it should be used when initializing call management interfaces or when needing to synchronize local label data with the current state in dialpad. note that this endpoint does not provide information about which labels are applied to specific calls; it only returns the set of available labels.

• Action
  Get Call Subscription Details

  Retrieves a list of call subscriptions associated with the authenticated user's account in the dialpad platform. this endpoint allows developers to fetch details about existing call event subscriptions, which are used to receive real-time updates on call states and activities. it should be used when an application needs to monitor or manage the current set of call subscriptions, such as for auditing purposes or to verify the existence of specific subscriptions. the endpoint does not create, modify, or delete subscriptions; it only provides read access to the existing subscription data. note that the response may include various types of call subscriptions, and developers should be prepared to handle different subscription formats or filters that may be present in the returned data.

• Action
  Get Channel Members By Id

  Retrieves a list of members for a specific channel in dialpad. this endpoint allows you to fetch user information for all members associated with the given channel id. it's useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing channel activity. the endpoint should be used when you need to access member details for a particular channel, such as when displaying member lists, checking channel membership, or performing channel-related operations that require knowledge of its members. note that this endpoint only provides member information and does not modify the channel or its membership.

• Action
  Get Departments By Office Id

  Retrieves a list of all departments associated with a specific office in the dialpad system. this endpoint is essential for understanding the organizational structure within a company's dialpad account. it should be used when there's a need to view, manage, or analyze the departmental breakdown of a particular office. the endpoint provides a comprehensive overview of the office's internal structure, which can be valuable for administrative tasks, reporting, or integration with other systems. note that this endpoint only returns department information and does not provide details about individual users within those departments.

• Action
  Get Deskphones For User Parent Id

  Retrieves a list of deskphones associated with a specific user in the dialpad system. this endpoint is useful for managing and tracking the deskphone inventory assigned to individual users within an organization. it can be used to audit user equipment, troubleshoot connectivity issues, or gather information for user setup and onboarding processes. the endpoint returns details about all deskphones linked to the specified user, which may include information such as deskphone models, serial numbers, and configuration status. this tool should be used when you need to obtain a comprehensive view of a user's assigned deskphone equipment in dialpad.

• Action
  Get Deskphones In Rooms

  Retrieves a list of deskphones associated with a specific room in the dialpad system. this endpoint is used to get detailed information about the communication devices deployed in shared spaces such as conference rooms, reception areas, or phone booths. it provides an overview of the deskphones' configuration and status within the context of a particular room. use this endpoint when you need to inventory, manage, or troubleshoot deskphones in a specific location. the response likely includes details such as deskphone models, serial numbers, configuration status, and any associated user information. this tool is particularly useful for it administrators and facilities managers who need to maintain an up-to-date record of communication equipment in various rooms across the organization.

• Action
  Get Office Call Centers

  Retrieves a list of call centers associated with a specific office in the dialpad platform. this endpoint allows administrators and developers to fetch information about all call centers within a given office, which is useful for managing and organizing communication resources. use this endpoint when you need to get an overview of call center units within an office, such as for reporting, resource allocation, or integration purposes. the endpoint returns basic information about each call center, but detailed configuration or real-time status may require additional api calls.

• Action
  Get Phone Number Details

  Retrieves detailed information about a specific phone number associated with the dialpad account. this endpoint allows you to fetch comprehensive data about a single phone number, including its current status, assigned user or department, tags, and other relevant attributes. use this endpoint when you need to access or verify the details of a particular phone number within your dialpad system. it's particularly useful for auditing phone number assignments, checking number status, or retrieving associated metadata. the endpoint does not modify any data and is safe for frequent use, making it ideal for real-time information retrieval or periodic synchronization with external systems.

• Action
  Get Rooms List

  Retrieves a list of all available meeting rooms or spaces within the dialpad system. this endpoint is essential for managing and organizing video-enabled meetings, allowing users to view and select appropriate meeting spaces for their needs. it provides an overview of both physical conference rooms and virtual meeting spaces, supporting dialpad's hybrid team collaboration features. use this endpoint when you need to display available rooms, check room capabilities, or integrate room selection into scheduling workflows. the response likely includes details such as room names, capacities, available equipment (e.g., poly studio x integration), and potentially real-time availability status. this endpoint does not create or modify rooms; it's purely for fetching room information. keep in mind that the returned data may need to be combined with calendar integration data to provide a complete picture of room availability.

• Action
  Get Subscription Contact By Id

  Retrieves the subscription information for a specific contact in the dialpad system. this endpoint allows you to access details about a contact's current subscription status, type, and related information. use this when you need to check or verify the subscription details for a particular contact, such as during account management or support processes. the endpoint focuses solely on subscription data and does not provide other contact information or modify any existing data. it's particularly useful for scenarios involving subscription management, billing inquiries, or when integrating dialpad's contact subscription system with other applications.

• Action
  Get User Caller Id

  Retrieves the caller id information for a specific user in the dialpad system. this endpoint allows you to fetch the current caller id settings associated with a user's account, which may include their display name, phone number, or other identifying information used when making outbound calls. it's particularly useful for administrators or integrations that need to verify or display a user's current caller id configuration. the endpoint should be used when you need to check or display a user's caller id settings, but not for modifying these settings. note that this endpoint only provides read access to the caller id information and cannot be used to update or change the caller id settings.

• Action
  Get User E911 Details

  Retrieves the enhanced 911 (e911) information for a specific user in the dialpad system. this endpoint provides critical location data associated with the user's account, which is essential for emergency services to accurately locate the caller during an emergency. it should be used when setting up or verifying a user's emergency contact information, ensuring compliance with e911 regulations for voip services. the tool returns the current e911 configuration for the specified user, including registered address and any additional location details. it's important to note that this endpoint only retrieves information and does not modify any e911 settings.

• Action
  Get Webhooks Information

  Retrieves a list of all webhooks configured for the authenticated user's dialpad account. this endpoint allows developers to view and manage their existing webhook subscriptions for various communication events such as calls, sms, contacts, and agent status changes. it should be used when you need to audit your current webhook configurations, verify the status of your integrations, or gather information before modifying existing webhooks. the endpoint provides an overview of active webhooks but does not include detailed event data or allow for webhook creation or modification.

• Action
  List Channels Api

  Retrieves a list of all available communication channels in the dialpad platform. this endpoint provides an overview of the various channels that can be used for voice, sms, and other digital engagement methods within dialpad. it should be used when you need to obtain information about the communication options available to your account or organization. the endpoint returns details about each channel, which may include channel ids, types (e.g., voice, sms), and their current status. this tool is particularly useful for applications that need to dynamically adjust their communication strategies based on available channels or for monitoring the health and availability of different communication methods in dialpad. note that this endpoint likely returns only basic channel information and may not include detailed usage statistics or real-time activity data.

• Action
  List Offices Endpoint

  Retrieves a list of offices within the dialpad platform. this endpoint provides access to office information, which is crucial for managing multiple offices in an organization using dialpad. it should be used when you need to obtain an overview of all offices or gather specific details about offices registered in the dialpad system. the endpoint likely returns essential information such as office names, locations, administrators, and possibly user counts or other relevant metadata. it's important to note that this endpoint does not modify any office data and is intended for read-only operations. keep in mind that the returned data may be subject to the user's permissions within the dialpad system.

• Action
  List Users

  Retrieves a list of users from the dialpad system. this endpoint allows you to fetch user account information, which is essential for user management and provisioning tasks. it can be used to sync user data with external systems, perform audits, or gather information for reporting purposes. the endpoint likely supports pagination and filtering options to manage large sets of user data efficiently. however, it does not provide real-time updates or webhook functionality for user changes - separate endpoints or features would be needed for those use cases.

• Action
  Modify Contact Details Using Id

  Updates an existing contact's information in the dialpad system. this endpoint allows for partial updates of contact details, including personal information, communication details, and associated urls. it's used when you need to modify or add information to an existing contact record. the endpoint supports updating multiple fields simultaneously, making it efficient for bulk changes or comprehensive contact updates. note that all fields are optional, allowing for targeted updates without affecting other contact information. when updating list-based fields like emails or phones, the provided lists will replace the existing data entirely.

• Action
  Modify Webhook Configuration

  Updates an existing webhook configuration in the dialpad api. this endpoint allows you to modify the destination url and/or the secret used for request validation of a specific webhook. use this when you need to change where webhook events are sent or update the security settings of an existing webhook. the endpoint is particularly useful for maintaining webhook configurations as your integration evolves or when you need to rotate security credentials. note that updating these settings will affect all future events for this webhook, so ensure your receiving endpoint is prepared for the changes before updating.

• Action
  Move User To Specified Office

  Updates a user's office assignment within the dialpad system. this endpoint allows administrators to move a user from their current office to a different office. it should be used when there's a need to change a user's organizational association, such as during departmental transfers or office relocations. the operation is performed by specifying the user's id in the url path and optionally providing the new office id in the request body. if no office id is provided, the user's current office assignment remains unchanged. this endpoint is particularly useful for managing organizational structure and ensuring users are correctly associated with their respective offices in dialpad.

• Action
  Patch Department Details By Id

  Updates the settings and configuration of a specific department in the dialpad system. this endpoint allows for comprehensive modification of department properties, including operating hours, call routing strategies, hold queue settings, and voice intelligence features. it's particularly useful for adjusting department behavior to match changing business needs or to optimize call handling efficiency. the endpoint supports partial updates, allowing you to modify only the specific fields you need to change without affecting other settings.

• Action
  Patch Subscription Changelog Endpoint

  Updates an existing change log event subscription in the dialpad system. this endpoint allows you to modify the status of a subscription and associate it with a specific logging endpoint. use this when you need to enable or disable notifications for system changes or when you want to change the destination for these notifications. the endpoint is particularly useful for managing event-driven integrations and maintaining up-to-date information flows between dialpad and external systems. note that updating a subscription does not create new events; it only affects future notifications for the specified change log.

• Action
  Patch User Status

  Updates the status of a specific user in the dialpad system. this endpoint allows you to set or modify a user's status message and optionally specify an expiration time for that status. it's particularly useful for indicating a user's availability, current activity, or temporary absence. the endpoint should be used when you need to programmatically update a user's status, such as integrating with calendar systems, automatic out-of-office settings, or custom workflow automations. it's important to note that this endpoint updates the status for a single user identified by their id in the url path. the status update is immediate, and if an expiration is set, the status will automatically clear at the specified time. this tool does not retrieve the current status; it only updates it. if you need to fetch the current status before updating, you would need to use a separate get endpoint (not provided in this schema).

• Action
  Patch Websocket Signature Secret

  Updates the signature secret for a specific websocket connection in the dialpad platform. this endpoint allows you to modify the authentication mechanism used to validate incoming requests to the websocket. use this when you need to rotate the secret for security reasons or when setting up a new authentication scheme for an existing websocket. the update affects future validations and may require updating the secret on the client-side as well. be cautious when using this endpoint, as it can potentially disrupt active connections if not managed properly. note that setting the secret to null effectively removes any signature validation for the websocket, which should only be done if alternative security measures are in place.

• Action
  Post Call Event Subscription

  Creates a new call event subscription in the dialpad system, allowing real-time notifications for various call states and actions. this endpoint enables developers to set up targeted event streams for specific call centers, users, or other entities within dialpad. use this when you need to monitor call activities, automate workflows based on call states, or integrate dialpad's call data with external systems. the subscription can be fine-tuned to listen for specific call states and target types, making it versatile for various use cases such as call monitoring, analytics, or custom integrations. note that while the subscription can be created with this endpoint, you'll need to have a properly configured webhook or websocket to receive the events.

• Action
  Post Subscription Change Log Event

  Creates or updates a subscription for changelog events in the dialpad system. this endpoint allows developers to set up real-time notifications for changes and updates within dialpad, such as api modifications, feature releases, or system updates. by configuring this subscription, you can ensure your application stays informed about important changes that may affect its integration with dialpad. the subscription can be enabled or disabled as needed, and notifications are sent to a pre-configured webhook or websocket endpoint. use this when you need to monitor dialpad's evolving features and api changes to maintain compatibility and leverage new functionalities promptly.

• Action
  Post Websocket Connection Secret

  Creates a websocket connection for real-time communication with the dialpad platform. this endpoint enables applications to establish a persistent, full-duplex connection for receiving live updates and event notifications from dialpad. use this when you need to implement features that require instant updates, such as live call status changes, message delivery notifications, or agent availability updates. the websocket connection allows for efficient, low-latency communication, reducing the need for frequent polling of other api endpoints. note that while this endpoint creates the connection, you'll need to implement appropriate event listeners and handlers in your application to process the incoming data streams effectively.

• Action
  Remove Blocked Numbers

  Removes specified phone numbers from the blocked list in the dialpad system. this endpoint allows you to unblock multiple phone numbers in a single api call, streamlining the process of managing blocked numbers. use this when you need to restore communication capabilities with previously blocked numbers, such as when a number is no longer considered spam or when a block was applied in error. the endpoint accepts a list of e164 formatted numbers, ensuring standardized input across different countries and number formats. note that this operation is irreversible; once numbers are removed from the blocked list, they will be able to communicate with your dialpad account unless blocked again.

• Action
  Retrieve Agent Status Subscription

  Retrieves a list of agent status subscriptions from the dialpad system. this endpoint allows you to fetch real-time information about the current subscriptions to agent status events. it is useful for monitoring which agents or systems are subscribed to receive updates about changes in agent statuses, such as availability or activity. this tool should be used when you need to audit or manage the subscriptions related to agent status events in your dialpad integration. note that this endpoint does not provide the actual agent statuses, but rather information about the subscriptions to these status updates.

• Action
  Retrieve App Settings

  Retrieves the current application settings for the authenticated dialpad account. this endpoint provides access to various configuration options and preferences set for the dialpad application. it should be used when you need to review or audit the current app settings, such as user interface preferences, notification settings, or integration configurations. the endpoint returns a comprehensive list of all available settings, which can be useful for troubleshooting, customization, or ensuring consistency across different instances of the application. note that this endpoint is read-only and does not allow for modifying settings; separate endpoints would be required for updating individual settings.

• Action
  Retrieve Blocked Number Details

  Retrieves information about a specific blocked number in the dialpad system. this endpoint allows users or administrators to check if a particular phone number is currently blocked. it's useful for verifying the status of a number before attempting communication or when reviewing security settings. the endpoint returns details about the blocked number, which may include when it was blocked and any associated metadata. it should be used when there's a need to confirm the blocked status of a specific number, but it won't provide a list of all blocked numbers or modify any existing blocks.

• Action
  Retrieve Blocked Phone Numbers

  Retrieves a comprehensive list of all phone numbers that have been blocked through the dialpad api. this endpoint is useful for managing call blocking settings and reviewing the current state of blocked numbers associated with your dialpad account. it provides a straightforward way to fetch all blocked numbers without the need for additional parameters. use this endpoint when you need to audit your blocked number list, verify if a specific number is blocked, or prepare for bulk operations on blocked numbers. keep in mind that this endpoint only returns numbers blocked via the api and may not include numbers blocked through other methods in the dialpad interface.

• Action
  Retrieve Call Centers Information

  Retrieves a list of call centers and their associated information from the dialpad platform. this endpoint allows developers to fetch details about all call centers configured in the dialpad account, including their settings, agent statuses, and operational metrics. it's particularly useful for applications that need to monitor or manage multiple call centers, analyze call center performance, or integrate call center data with other systems. the endpoint returns comprehensive data about each call center, which can be used for reporting, dashboard creation, or automating call center management tasks. note that this endpoint provides a high-level overview of call centers and may not include granular details about individual calls or agents.

• Action
  Retrieve Call Information

  Retrieves call information from the dialpad system. this endpoint allows you to fetch details about one or more calls, which may include call duration, participants, timestamps, and other relevant metadata. it can be used to gather historical call data for analysis, reporting, or integration with other systems. the endpoint does not provide real-time call control or the ability to initiate new calls. note that the specific details returned may vary based on user permissions and the scope of the api token used.

• Action
  Retrieve Call Subscription By Id

  Retrieves detailed information about a specific call subscription in the dialpad system. this endpoint allows developers to access the current state and configuration of a call subscription, which is used for tracking and receiving notifications about call-related events. it's particularly useful for monitoring the status of automated workflows or integrations that depend on call data. the endpoint should be used when you need to check the details of a single, known call subscription, such as its activation status, associated phone numbers, or event types it's configured to track. it will not modify the subscription or return data about multiple subscriptions.

• Action
  Retrieve Channel By Id

  Retrieves detailed information about a specific communication channel in the dialpad platform using its unique identifier. this endpoint allows developers to fetch comprehensive data about a particular channel, which can include its type (e.g., voice, video, or messaging), current status, associated users or groups, and other relevant metadata. it is particularly useful when you need to access or verify the properties of a specific channel within your application. the endpoint should be used when detailed information about a known channel is required, such as during channel management tasks, reporting, or when integrating channel-specific features into your application. note that this endpoint only provides information for a single channel at a time and does not support batch retrieval or listing of multiple channels.

• Action
  Retrieve Coaching Stats V2

  The getstatistics endpoint retrieves comprehensive statistics for various aspects of dialpad usage, including calls, customer satisfaction (csat), dispositions, on-duty status, recordings, screen shares, texts, and voicemails. it offers flexible options for targeting specific users, groups, or offices, and allows for customized date ranges and aggregation methods. this endpoint is particularly useful for analyzing performance metrics, tracking customer satisfaction, and gaining insights into communication patterns within an organization. it supports both aggregated statistics and individual record retrieval, making it versatile for different analytical needs. however, users should note that certain stat types (like csat and dispositions) require specific targeting parameters and only support individual record retrieval.

• Action
  Retrieve Coaching Teams Information

  Retrieves information about coaching teams in the dialpad platform. this endpoint allows users to fetch details about existing coaching teams, which are essential for managing call monitoring, feedback, and agent performance improvement. it provides an overview of team structures, including coaches, trainees, and associated settings. the endpoint is useful for administrators and managers who need to review or manage coaching team configurations across the organization. note that while this endpoint retrieves team information, it does not modify any team settings or structures.

• Action
  Retrieve Company Data

  Retrieves detailed information about a specific company within the dialpad platform. this endpoint allows developers to access various company-level data, such as company name, settings, and other relevant details. it should be used when an application needs to fetch or display company information, update local records, or verify company-specific configurations. the endpoint provides a comprehensive view of a company's profile in dialpad but does not modify any data. note that the specific fields returned may depend on the user's permissions and the company's privacy settings.

• Action
  Retrieve Contact By Id

  Retrieves detailed information for a specific contact in your dialpad account using the contact's unique identifier. this endpoint allows you to fetch comprehensive data about a single contact, including their name, phone numbers, email addresses, and any custom fields associated with the contact. use this when you need to access or display detailed information about a particular contact in your application. the endpoint is useful for scenarios such as populating contact details in a crm integration or displaying contact information during an active call. note that this endpoint only retrieves information for one contact at a time and does not support batch retrieval or searching across multiple contacts.

• Action
  Retrieve Contact List

  Retrieves a list of contacts from the dialpad platform. this endpoint allows you to fetch contact information, which is crucial for managing user data and communication records within your dialpad-integrated application. it supports pagination, searching, and sorting to efficiently handle large contact lists. use this endpoint when you need to access or display contact information, sync contacts with other systems, or perform contact-related operations in your application. the endpoint returns basic contact details, but may not include sensitive information or full communication history.

• Action
  Retrieve Department By Id

  Retrieves detailed information about a specific department within the dialpad organization. this endpoint allows you to fetch comprehensive data about a department, including its name, description, member count, and other relevant attributes. use this endpoint when you need to access or display information about a particular department, such as for department management interfaces or generating reports. the endpoint returns the most up-to-date information available for the specified department. note that this endpoint only provides read access to department data and cannot be used to modify department information.

• Action
  Retrieve Department Operators By Id

  Retrieves a list of operators associated with a specific department in dialpad. this endpoint allows you to fetch detailed information about the operators assigned to a particular department, enabling efficient management of department resources and personnel. use this endpoint when you need to review, audit, or manage the operators within a specific department. the response likely includes operator details such as names, contact information, and roles. note that this endpoint does not modify any department or operator data; it is for retrieval purposes only. it's particularly useful for administrative tasks, reporting, and ensuring proper staffing across departments.

• Action
  Retrieve E911 Office Details

  Retrieves the enhanced 911 (e911) settings for a specific office within the dialpad communication platform. this endpoint allows administrators to fetch crucial emergency service configuration details associated with a particular office location. it should be used when auditing or verifying e911 compliance, updating emergency response information, or integrating office-specific emergency settings into external systems. the endpoint provides read-only access to e911 data and does not allow modifications. it's important to note that this tool only retrieves settings for a single office at a time and does not provide aggregate data across multiple offices.

• Action
  Retrieve List Of Departments

  Retrieves a list of departments for a specified office within the dialpad organization. this endpoint is essential for obtaining the organizational structure and can be used to populate department selectors, generate reports, or manage team assignments. it returns basic information about each department, such as its name, id, and possibly the number of members. the endpoint should be used when needing an up-to-date view of the departmental structure within an office. it does not provide detailed information about individual department members or historical data about department changes. pagination parameters may be necessary for offices with a large number of departments to manage response sizes and api performance.

• Action
  Retrieve Numbers Via Api V2

  Retrieves a list of phone numbers associated with the user's dialpad account. this endpoint allows users to view all the phone numbers they have access to, which may include both assigned and unassigned numbers. it's useful for inventory management, number allocation, and auditing purposes. the endpoint returns basic information about each number, such as its value, status, and associated user or department. it does not modify any data and is safe for frequent polling. note that the response may be paginated for large number inventories, and additional calls may be needed to retrieve the full list.

• Action
  Retrieve Off Duty Status By Office Id

  Retrieves the list of custom off-duty statuses for a specific office within the dialpad system. this endpoint is used to fetch and manage the availability statuses of agents assigned to a particular office. it provides administrators and supervisors with insights into why agents might be stepping away from their desks, helping to track and understand agent activity. the endpoint should be used when there's a need to review, update, or manage the off-duty status options for a given office. it's particularly useful for larger organizations with multiple offices that may have different sets of off-duty statuses. note that this endpoint only retrieves the statuses and does not provide real-time information about which agents are currently using each status.

• Action
  Retrieve Office By Id

  Retrieves detailed information about a specific office within the dialpad system. this endpoint should be used when you need to access comprehensive data about a particular office, such as its name, location, assigned users, or custom settings. it's particularly useful for administrative tasks, reporting, or displaying office information in integrated applications. the endpoint returns all available details for the specified office, making it efficient for obtaining a complete office profile in a single api call. however, it does not allow for modifying office information or retrieving data for multiple offices simultaneously.

• Action
  Retrieve Office Plan By Id

  Retrieves the current plan details for a specific office in your dialpad organization. this endpoint allows you to fetch information about the subscribed features, limitations, and other plan-specific details for a given office. use this endpoint when you need to review or verify the current plan status of an office, such as during account management or when considering plan upgrades. the response will likely include details such as the plan name, included features, user limits, and any custom configurations. note that this endpoint only provides read-only access to plan information and cannot be used to modify or update the office plan.

• Action
  Retrieve Operator Duty Status

  Retrieves the current duty status of a specific call center operator in dialpad. this endpoint allows you to check whether an operator is active (available to receive inbound calls) or off-duty (not available for calls). use this endpoint when you need to determine an operator's availability in real-time, such as for load balancing, scheduling, or monitoring operator activity. the endpoint provides a snapshot of the operator's current status and does not include historical data or future scheduled statuses. it's particularly useful for systems that need to make routing decisions based on operator availability or for creating dashboards that display team capacity.

• Action
  Retrieve Room Information By Id

  Retrieves detailed information about a specific room in the dialpad system. this endpoint allows you to fetch the current state, settings, and properties of a virtual collaboration space identified by its unique id. use this when you need to access up-to-date information about a particular room, such as its name, participants, or configuration. the endpoint is particularly useful for applications that need to display room details or make decisions based on a room's current status. note that this endpoint only provides information and does not modify the room in any way.

• Action
  Retrieve Schedule Report By Id

  Retrieves detailed information about a specific scheduled report in the dialpad system. this endpoint allows you to fetch the configuration and metadata of a pre-defined report, which may include communication metrics, analytics, or other relevant data aggregated from dialpad's communication platform. use this endpoint when you need to access or review the settings of a particular scheduled report, such as its frequency, included data points, or last run time. it's particularly useful for auditing report configurations or preparing to update existing reports. note that this endpoint only retrieves the report configuration, not the actual report data itself. to get the latest generated report content, you may need to use a separate endpoint or check if this response includes a link to the most recent report output.

• Action
  Retrieve Sms Opt Out By Company Id

  Retrieves the sms opt-out list for a specific company within the dialpad platform. this endpoint allows you to fetch all phone numbers that have opted out of receiving sms messages from the specified company. use this endpoint when you need to check which recipients have unsubscribed from sms communications, ensuring compliance with messaging regulations and user preferences. the returned list can be used to update your contact database or messaging system to prevent sending unwanted messages. note that this endpoint only provides the opt-out information and does not modify the opt-out status of any recipients.

• Action
  Retrieve Sms Subscription By Id

  Retrieves detailed information about a specific sms subscription in dialpad. this endpoint allows developers to fetch the current status, configuration, and other relevant details of an sms subscription by providing its unique identifier. use this endpoint when you need to check the properties of an existing sms subscription, such as its active status, associated phone number, or any custom settings. it's particularly useful for managing and monitoring sms capabilities within your dialpad integration. note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.

• Action
  Retrieve Sms Subscriptions

  Retrieves a list of sms subscriptions associated with the authenticated user's dialpad account. this endpoint allows users to view and manage their current sms subscription plans and settings. it should be used when you need to obtain information about active sms subscriptions, such as subscription status, plan details, or associated phone numbers. the endpoint provides an overview of sms-related services but does not allow for modification of subscriptions. note that this endpoint may have pagination for large numbers of subscriptions, and additional calls might be necessary to retrieve the complete list.

• Action
  Retrieve Specific Webhook By Id

  Retrieves detailed information about a specific webhook configuration in the dialpad system. this endpoint allows developers to fetch the current status, settings, and event subscriptions for a particular webhook identified by its unique id. use this endpoint when you need to check the configuration of an existing webhook, verify its status, or retrieve its associated event types. it's particularly useful for troubleshooting webhook-related issues or auditing webhook configurations. the endpoint returns comprehensive data about the webhook, including its target url, subscribed events, and any custom headers or authentication settings.

• Action
  Retrieve Stat By Id

  Retrieves detailed statistics and analytics data for a specific entity within the dialpad platform. this endpoint allows you to access performance metrics, communication data, and other relevant statistics for a user, team, or call center identified by the provided id. use this endpoint when you need to analyze the performance or usage patterns of a particular entity within your dialpad organization. the data returned may include call volumes, average call durations, customer satisfaction scores, and other communication metrics. note that the specific metrics available may vary depending on the type of entity (user, team, or call center) and your organization's settings. this endpoint is particularly useful for generating reports, monitoring performance, and making data-driven decisions to improve communication efficiency and effectiveness.

• Action
  Retrieve Subscription Change Log

  Retrieves the changelog for dialpad api subscriptions. this endpoint provides a historical record of changes and updates made to subscription events and notifications within the dialpad system. it's useful for tracking modifications to webhooks, event subscriptions, and other notification-related configurations over time. the changelog can help developers understand when and how subscription settings have been altered, aiding in troubleshooting and maintaining up-to-date integrations. note that while the endpoint doesn't appear to require specific parameters, it may support optional query parameters for filtering or pagination, which are not visible in the provided schema.

• Action
  Retrieve Subscription Change Log By Id

  Retrieves the changelog for a specific subscription in the dialpad system. this endpoint allows you to access a historical record of changes made to a particular subscription, including updates, modifications, or status changes. it is useful for auditing purposes, troubleshooting issues, or tracking the evolution of a subscription over time. the endpoint returns a chronological list of changes, likely including details such as the date of change, type of change, and any relevant metadata. note that this endpoint only provides changelog information and does not allow for modifying the subscription itself.

• Action
  Retrieve Subscription Contacts

  Retrieves subscription information for contacts in the dialpad system. this endpoint allows you to fetch details about contact event subscriptions, which are crucial for receiving real-time notifications about contact-related events such as updates, calls, or sms activities. use this endpoint when you need to monitor or manage the current contact subscriptions in your dialpad integration. it provides a comprehensive view of all active contact subscriptions, enabling you to track which contact events you're currently listening to. note that this endpoint likely returns all contact subscriptions associated with your account, and may not support filtering or pagination in the request.

• Action
  Retrieve Teams For Office Id

  Retrieves a list of teams associated with a specific office in the dialpad organization. this endpoint is useful for getting an overview of the team structure within a particular office, which can be valuable for administrative tasks, reporting, or integrating dialpad's organizational structure with other systems. it should be used when you need to obtain information about multiple teams within a single office context. the endpoint will not provide detailed information about individual team members or their communications; it focuses solely on team-level data within the specified office.

• Action
  Retrieve User Devices List

  Retrieves a list of devices associated with users in the dialpad system. this endpoint allows you to fetch information about various communication devices used within your dialpad organization, such as desk phones, softphones, or mobile devices. use this endpoint when you need to inventory or manage the devices connected to user accounts, track device usage, or troubleshoot device-related issues. the response likely includes details such as device type, status, associated user, and device-specific information. this tool is particularly useful for administrators managing a large number of devices across their organization or for integrating device information into custom dashboards or management systems. note that while the endpoint doesn't specify any parameters, it may support query parameters for filtering results, such as by user id or device type. the exact structure of the response and any available filters would need to be confirmed in the full api documentation.

• Action
  Retrieve User Personas By Id

  Retrieves all personas associated with a specific user in the dialpad system. this endpoint allows you to fetch the various identities or roles that a user can assume when making calls, providing detailed information about each persona. use this endpoint when you need to display or manage the different caller identities available to a user. the response will include a list of persona objects, each containing information such as the persona name, phone number, and any associated metadata. this endpoint is particularly useful for applications that need to offer users a choice of outbound caller identities or for administrative purposes to review a user's available personas.

• Action
  Retrieve Websocket By Id

  Retrieves detailed information about a specific websocket connection using its unique identifier. this endpoint allows developers to query the status, metadata, and other relevant details of an active or recent websocket connection in the dialpad system. it's particularly useful for monitoring real-time event subscriptions, troubleshooting connection issues, or auditing websocket usage. the endpoint should be used when you need to inspect or verify the state of a particular websocket connection, such as checking if it's still active or retrieving its configuration. note that this endpoint provides information about the connection itself and may not include the actual event data being transmitted through the websocket.

• Action
  Retrieve Websocket Connection

  Retrieves information about websocket connections or initiates a websocket connection for real-time event subscriptions with dialpad. this endpoint is essential for applications that require live updates and real-time communication capabilities within the dialpad platform. it enables developers to establish a persistent connection for receiving instant notifications about various events such as calls, sms, contacts, agent status, and system changes. use this endpoint when building applications that need to react immediately to dialpad events or maintain a live data stream. note that while this endpoint provides the websocket connection details, you may need to implement the websocket client separately to handle the actual connection and data exchange.

• Action
  Set User Caller Id By Id

  Sets or blocks the caller id for a specific dialpad user. this endpoint allows you to define the phone number that will be displayed when the user makes outgoing calls, or to block the caller id entirely. use this when you need to customize how a user's calls appear to recipients or to ensure privacy by blocking the caller id. the endpoint is particularly useful for managing professional appearances in business communications or for compliance with privacy regulations. note that this setting affects all outgoing calls made by the user through the dialpad platform.

• Action
  Subscribe Contact Event

  Creates a new contact event subscription in the dialpad platform, allowing you to receive real-time updates about changes to contacts. this endpoint enables you to subscribe to events for either local (personal) or shared (organization-wide) contacts. use this when you need to integrate contact management functionalities or automate workflows based on contact updates in your dialpad-connected application. the subscription can be linked to a specific logging endpoint (webhook or websocket) for event delivery and can be enabled or disabled upon creation. note that you must have previously set up a logging endpoint to receive the events if you specify an endpoint id.

• Action
  Toggle User Do Not Disturb Status

  The toggleuserdonotdisturb endpoint allows you to update the do not disturb (dnd) status for a specific user in the dialpad system. this powerful feature enables programmatic control over a user's availability, helping to manage notifications and improve focus time. the endpoint can be used to enable or disable dnd for an individual user, and optionally within the context of a specific group (such as a call center, department, or office). this granular control makes it ideal for implementing custom availability management solutions or integrating with external scheduling systems. keep in mind that changing a user's dnd status may affect their ability to receive incoming communications, so use this endpoint judiciously and in accordance with your organization's communication policies.

• Action
  Update Call Subscription By Id

  Updates an existing call event subscription in the dialpad system. this endpoint allows you to modify various aspects of a subscription, including the call states to monitor, the subscription's active status, associated logging endpoint, and event filtering criteria. use this when you need to adjust the behavior of an existing subscription, such as changing which call events you receive notifications for or updating the target of the subscription. it's particularly useful for fine-tuning your application's integration with dialpad's real-time call event system. note that this endpoint updates only the specified fields; unspecified fields retain their current values.

• Action
  Update Contact Information

  Updates an existing contact's information in the dialpad system. this endpoint allows you to modify various details of a contact, including their name, company, contact information, and job details. it's particularly useful for keeping contact records up-to-date or correcting information. the endpoint requires at least the first name, last name, and a unique identifier (uid) to update a contact. other fields such as email addresses, phone numbers, and urls can be optionally updated. note that this endpoint overwrites existing data, so include all current information along with any changes to avoid unintended data loss.

• Action
  Update Contact Subscription By Id

  Updates an existing contact event subscription in the dialpad system. this endpoint allows you to modify the configuration of a subscription, including changing the contact type it listens for, enabling or disabling the subscription, and associating it with a different logging endpoint. use this when you need to adjust the behavior of an existing contact event subscription, such as changing its scope from local to shared contacts or temporarily disabling event notifications. the subscription id must be provided in the url path. note that this endpoint only updates the specified fields; any fields not included in the request will retain their current values.

• Action
  Update E911 Address For Office

  This endpoint updates the enhanced 911 (e911) address for a specific office in dialpad. it allows you to modify crucial location information used by emergency services to accurately locate the office in case of an emergency call. the endpoint can update the address for the office itself and optionally for all users associated with that office. it also provides an option to validate the address using dialpad's service, ensuring the highest possible accuracy for emergency response. use this endpoint when setting up a new office, relocating an existing office, or correcting address information. it's particularly important for maintaining compliance with e911 regulations and ensuring employee safety.

• Action
  Update E911 Address For User

  Updates the e911 address for a specified user in the dialpad system. this endpoint allows you to modify the emergency location information associated with a user's account, ensuring accurate dispatch of emergency services if needed. the updated address will be used for e911 services, which provide precise location data to emergency responders. this tool should be used when a user's physical location changes or when correcting inaccurate e911 address information. it's crucial for maintaining compliance with e911 regulations and ensuring user safety. the endpoint requires detailed address information and offers an option for address validation to improve accuracy.

• Action
  Update Room Details

  Updates the configuration of a specific dialpad room identified by its id. this endpoint allows you to modify the room's name and manage its assigned phone numbers. use this when you need to rename a room, update its phone number assignments, or reorder existing phone numbers. the endpoint is particularly useful for maintaining accurate room information and adjusting telephony settings as your organization's needs change. note that this is a partial update operation, so only the fields you provide will be modified. be cautious when updating phone numbers, as reordering or removing numbers from the list will affect their assignment to the room.

• Action
  Update Schedule Report Settings

  The updatescheduledreport endpoint allows you to modify the settings of an existing scheduled report in dialpad. this powerful tool enables fine-tuning of report generation parameters, including frequency, timing, type, and scope. use this endpoint when you need to adjust report schedules, change report types, update target information, or modify other settings of a previously configured report. the endpoint is particularly useful for adapting reporting needs as your organization's requirements evolve. it provides flexibility in managing various aspects of scheduled reports, from basic timing adjustments to more complex changes in report focus and delivery. keep in mind that this endpoint updates an existing report schedule; it does not create new schedules or generate reports on demand. also, note that some parameters are interdependent (e.g., frequency, at, and on day), so ensure their values are consistent when making updates.

• Action
  Update Sms Subscription Settings

  Updates an existing sms event subscription in the dialpad api. this endpoint allows you to modify various aspects of an sms subscription, such as its direction, enabled status, associated endpoint, and target settings. use this when you need to change the configuration of an existing sms event subscription to adjust its behavior or scope. the endpoint provides flexibility in updating multiple parameters simultaneously, allowing for fine-tuned control over sms event notifications. note that all parameters are optional, so you can update only the specific fields you want to change without affecting the others.

• Action
  Update User Information By Id

  This endpoint allows you to update various aspects of a user's profile and settings in the dialpad system. it provides comprehensive control over user management, including personal information, administrative roles, communication settings, and account status. use this endpoint when you need to modify existing user data, such as changing contact details, adjusting administrative privileges, updating license types, or managing phone numbers and extensions. the endpoint is particularly useful for keeping user information up-to-date and managing user access within the dialpad platform. note that some changes, like updating license types or office assignments, may have billing implications. ensure you have the necessary permissions and understand the impact of changes before using this endpoint.

No trigger or action matches that. Ask your agent to add it: it reads the API documentation and builds what you describe.