Integration
Connect Decile Hub to Dialpad
When New Event fires in Decile Hub, your agent runs Create New Contact Entry in Dialpad. Describe the whole flow and it is built, tested on every scenario and kept running.
What the catalog holds today. Ask for anything missing and your agent reads the API documentation and adds it.
Build solutions, not workarounds.
What do you want Decile Hub and Dialpad to do together?
Ask the assistant
Connect your AI client
Give your AI client this address.
https://mcp.apiant.aiOne connection does both: ask your client to act in an app once, or have it build an automation that keeps running. Any client that takes a remote MCP server. Nothing to install. Create your free account, then sign in once in your browser.
Set it up in your client
Claude Code
Run this in the directory you want to work in.
claude mcp add --transport http -s project apiant-ai https://mcp.apiant.aiStart Claude Code there, approve the server, and sign in in the browser page it opens.
Claude Code guide (opens in a new tab)Claude, web and desktop
Open Customize, then Connectors, then Add custom connector, and paste the address. On Team and Enterprise an owner adds it first.
Setup guide (opens in a new tab)Cursor
Add the address to your MCP configuration as a server URL. Cursor signs you in in your browser.
Setup guide (opens in a new tab)Zed
Open Settings, then AI, then MCP Servers, then Add Server, then Add Remote Server.
Setup guide (opens in a new tab)Codex and the ChatGPT desktop app
Open Settings, then MCP servers, then Add server, and choose Streamable HTTP. From the terminal, Codex takes the address with its own add command and then signs you in.
Setup guide (opens in a new tab)Grok
Open grok.com/connectors, choose New Connector, then Custom, and paste the address. Grok signs you in in your browser.
Setup guide (opens in a new tab)Any other MCP client
Paste the address where the client asks for a remote MCP server URL, and name the server apiant-ai where it lets you. APIANT's skills reach the client over the same connection.
Setup guide (opens in a new tab)Example flows
What Decile Hub can start in Dialpad
When New Event in Decile Hub
then Create New Contact Entry in Dialpad
When New Organization in Decile Hub
then Create New Department Record in Dialpad
Starting points drawn from the triggers and actions in the catalog today. Describe the flow you need, at any depth, and your agent builds it and tests every scenario before it ships.
Everything your agent can do with Decile Hub and Dialpad
Triggers and actions 5 triggers · 431 actions
Trigger
New EventTriggers when a new event is created.
Trigger
New OrganizationTriggers when a new organization is added to the directory.
Trigger
New PersonTriggers when a new person is added to the directory.
Trigger
New TaskTriggers when a new task is created.
Trigger
Pipeline Prospect ChangedTriggers when a pipeline prospect is added or changed.
Action
Accept a reply as an answer to a Base post, or unaccept itAccepts a reply as an answer to its Base post as the user who owns the API key — the same as Accept in the Base UI. Only the post's author (or a Decile admin) can do this. `accepted` defaults to true; set it to false to take the acceptance back. Both directions are idempotent. Available to any API k
Action
Add a Deal Memo commentAdd a comment to a deal memo as the API key's user. This is where notes, meeting takeaways and email context about the deal belong: the comment appears on the memo's comments/review thread and notifies the memo's reviewers. Plain text is kept as written and blank lines become paragraphs; HTML is sto
Action
Add a due diligence task to a Deal MemoAdds one task to the checklist on the memo's Diligence tab. `status`
Action
Add a message to a Task threadPosts a message on the Task's thread and notifies the other people on the task. Anyone who can open the task can post.
Action
Add a note to an organizationAppend a plain-text note to an organization. The note is stored on the organization
Action
Add a note to a personAppend a plain-text note to a person. The note is stored on the person and surfaced
Action
Add a note to a pipeline prospectAppend a plain-text note in the context of a pipeline prospect. To match the in-app
Action
Add a scheduled deal pullAdds a scheduled deal pull, as "Add scheduled pull" in the Deals
Action
Add Event GuestAdd multiple guests to an event. Guests will be created as People if they don't exist and added to the event pipeline. The response includes arrays of added, duplicate, and error results for processing feedback.
Action
Adds a stage to a pipelineAdds a new stage at the END of the pipeline. Account admin authorization is required (account admins, or decile admins acting on the account).
Action
A fund's Venture Partner Agreements and whether a new one can startLists the Venture Partner Agreements (VPAs: grants of GP Class A units
Action
AI auto-fill enrichment for a deal shareRun AI auto-fill enrichment for a deal share. Given an organization in the caller's account and a list of deal-share form field names, the model reasons over the data Hub already holds (organization profile, deal memos, notes, documents) and returns suggested values for those fields. The organizatio
Action
Approve, decline, or complete an identity verification TaskRecords the assignee's action on an identity or accreditation
Action
Archive a Dex chatArchives one of your chats, as archiving it in Hub does. The chat leaves the chat sidebar; nothing is deleted.
Action
Archive Data Room ItemArchives a folder or file in Internal Firm Files. An archived item and everything under it is hidden from everyone in the account; only Decile can unarchive it. Needs data room manager or admin access.
Action
Archive or unarchive Decile Base inbox threadsArchives or unarchives the authenticated user's Base inbox threads by post ID (up to 200). Archiving takes a thread out of the inbox and marks it read; a later reply from someone else brings it back. Posts the user cannot see are skipped; `post_ids` in the response lists the posts it applied to.
Action
Archives a pipelineArchives the pipeline, as "Archive pipeline" on its Settings page does. The pipeline is hidden everywhere in the account; its prospects do not change. Only user-created pipelines can be archived.
Action
Ask one LP to increase their commitmentAsks this LP to increase their commitment, as the Hub "Request increase"
Action
Ask the Agreement Reviewer a questionAsks about a Decile agreement (template_slug) or your own uploaded document (upload_text and upload_filename from upload_agreement_for_review), optionally about one passage (selected_text). The answer is written in the background: the question comes back with status pending (202); poll get_agreement
Action
Bookmark a Base post or remove the bookmarkBookmarks a Base post as the user who owns the API key — the same bookmark the Base UI adds. Set `remove` to true to remove it. Both directions are idempotent. The acting user must be able to read the post. Available to any API key with Base access.
Action
Bulk capital-account period calculations + totalsPaginated bulk variant of the single-CA calculations endpoint.
Action
Cancels a scheduled emailDeletes a scheduled email so it never sends, the same as Delete in the pipeline's Scheduled emails panel. This cannot be undone. Requires permission to email the pipeline's prospects. An email that has sent returns 404. An email that starts sending during the request returns 409 `conflict` and is no
Action
Cancel TaskCancels a Task, as the task page's delete does. The task is kept with status cancelled, the optional reason is recorded, and the assignee is notified. Only the task creator or an account admin can cancel. Cannot be undone. Returns 422 when the task is already completed, cancelled, or expired.
Action
Change a contact's role on a capital accountChanges the fields given and leaves the rest. `id` is a
Action
Change a manager estimate and restate the approved official mark itFor an estimate flagged for review whose official valuation Fund
Action
Change an unpublished manager estimateOnly the fields passed change. To change the value, pass exactly one
Action
Change a person's title at an organizationChanges the title of a person linked to an organization. Needs an account admin or the directory role (403 otherwise).
Action
Change a teammate's title or permissionsChanges a teammate's title or permissions, as the Team page does. Only
Action
Change who can open a data roomChanges who can open the room, as the room's Access tab does.
Action
Close a Deal MemoClose a deal memo as Invested (approve), Passed (pass: the fund decided not to invest) or Lost (lost: the founder went elsewhere). Moves the Deal to the matching pipeline stage and dispatches the close notification. Passed and Lost take close_reasons, one or more of the account's reasons for that en
Action
Complete TaskMarks a Task as completed. Permitted for the task creator, current assignee, account owners/admins, and Decile admins.
Action
Compose and send an emailSends the previewed email. Request body is identical to
Action
Confirm a Deal MemoInvestment Committee only (Decile Group reviewers). The stage moves to
Action
Connects a pipeline to a fundConnects the pipeline to a fund of this account, as "Connect Fund" in Hub does. An empty `entity_id` disconnects it. Account admins only.
Action
Copy a prospect to another pipelineCopies a prospect into another pipeline of the same account, as the prospect's Copy to Pipeline
Action
Copy a shared deal into a pipeline stageCopy a network-feed shared deal into one of the caller account's pipeline stages. Get the deal id from list_deal_feed. Creates (or reuses) an organization in the caller's account and adds it as a prospect to the given stage, asynchronously. The pipeline_stage_id MUST belong
Action
Copy Decile Research Investors To PipelineCopies selected entries from the shared "Decile Research" LP roster
Action
Copy Folders and FilesCopies folders (with their contents) and files into another folder. Items that cannot leave an internal-only folder are skipped and counted in failed. System-managed folders cannot be copied.
Action
Count account-wide records by resource, with optional filtersReal, filterable COUNT(*) for a single resource on the caller's
Action
Create a custom data point for a pipeline typeCreate a custom data point (Variable) on the account, scoped to the **type** of the targeted pipeline (investor / company / etc). Data points are not attached to a single pipeline — they live at the account level under a type-specific context (e.g. `investor_data_points`, `company_data_points`). The
Action
Create a deal gateAdds a gate to the fund behind an investment pipeline. A new gate is a draft, which is inert, unless `status` is `active` (any other status is ignored). Agents always create a draft and turn gates on with activate_deal_gates, because the first active gate on a fund replaces its thesis-fit scores. Ne
Action
Create a draft newsletter with content and recipient filterCreates the newsletter, its companion pipeline and email template,
Action
Create a firm-admin entityCreates a new `AccountOrganization` plus a fresh `Organization` and (for
Action
Create an email template on a pipelineCreates a reusable email template on one of the account's pipelines.
Action
Create a single pipeline prospectCreates a Person or Organization prospect in a target pipeline — the
Action
Create a variableAdds a variable to a section of the Variables page. Account admin
Action
Create FolderCreates a new folder in your Files. You can optionally specify a parent folder by providing a parent_id. Folder names must be unique within the same parent folder.
Action
Create one journal entry under an entityCreates a single journal entry (general-ledger / accounting transaction —
Action
Create Organization ProspectsCreates Person/Organization pipeline prospects for a given pipeline. Only the first 100 organizations and first 100 people will be processed.A valid request will return a json object with two keys, organizations and people. Each key will have a created, duplicates, and errors array. The created arra
Action
Create OrganizationsAdds Organizations to your Organizations Directory. Only the first 100 Organizations per request will be processed.The response will have a created, duplicates, and errors array. The created array will contain the emails of the organizations that were created. The duplicates array will contain the e
Action
Create or update a Deal ShareShare a deal from the caller's account into the network feed. Idempotent per organization: if a Deal Share already exists for the given organization in the caller's account its attributes are updated; otherwise a new record is created. The target organization must belong to the caller's account — us
Action
Create PeopleAdds People to your People Directory. Only the first 100 People per request will be processed.The response will have a created, duplicates, and errors array. The created array will contain the emails of the people that were created. The duplicates array will contain the emails of the people that wer
Action
Create Personalized LinkGenerates a personalized data room preview link that grants a specific
Action
Create Person ProspectsCreates Person/Organization pipeline prospects for a given pipeline. Only the first 100 organizations and first 100 people will be processed.A valid request will return a json object with two keys, organizations and people. Each key will have a created, duplicates, and errors array. The created arra
Action
Creates a pipelineCreates a pipeline, the same as "Create New Pipeline" in Hub. Pass `name` and either `type` or `copy_from_pipeline_id`. Fundraising (`investor`), Dealflow (`investment`) and Connectors (`connector`) pipelines come with their standard stages and email templates; `custom` starts empty. `copy_from_pipe
Action
Create TaskCreates a task in Decile Hub and assigns it to a team member.
Action
Create/Update OrganizationCreate or Update an existing Organization. The request can only contain one Organization. A successful request will return a json object containing the success status, the organization_id, and a list of changes in the form of field_name: [old_value, new_value].
Action
Create/Update Organization ProspectCreate or update an existing pipeline prospect in a given pipeline. The request must contain exactly one of
Action
Create/Update PersonCreate or Update an existing Person. The request can only contain one Person. A successful request will return a json object containing the success status, the person_id, and a list of changes in the form of field_name: [old_value, new_value].
Action
Create/Update Person ProspectCreate or update an existing pipeline prospect in a given pipeline. The request must contain exactly one of
Action
Data Room File Visitor StatsShows who viewed a data room file through share links, as on the file's Activity panel, across all its versions. Returns views, unique visitors, downloads and average engagement in seconds, and each visitor (most recent first) with views, seconds viewed, downloads and last seen. Pass person_id for t
Action
Data Room Visitor StatsShows who visited a data room through share links, as on the room's Activity tab. Returns the room's visits, unique visitors, downloads and average engagement in seconds, visits per day, each visitor (most recent first) with visits, downloads and last seen, and the five most viewed files. Team membe
Action
Decide an Investment Committee checklist itemInvestment Committee only (Decile Group reviewers). Approves, accepts
Action
Delete a Deal MemoPermanently delete a deal memo, with its answers, comments, ratings, diligence tasks and files, as the memo list's delete does. The company and its pipeline deal stay. This cannot be undone. Only an account admin who can manage investments may delete a memo. A memo that backs a Start SPV application
Action
Delete a Deal Memo commentDelete a comment from a deal memo's thread. Only the comment's author or an account admin can delete it. Hard delete, as in the web UI. A comment id that is not on this memo is 404 not_found.
Action
Delete a Deal Memo material or term sheet, or unlink a linked fileRemoves a file from the memo by its `id` from the list endpoint. A
Action
Delete a deal share owned by the current accountPermanently deletes a deal share owned by the caller's account. The lookup
Action
Delete a Decile Base postPermanently deletes a Base post and all of its replies. This cannot be undone. Only the post's author may delete it (Decile admins may delete any post), and the acting user must still be able to see the post's channel.
Action
Delete a Decile Base replyPermanently deletes a Base reply and any replies nested under it. This cannot be undone. Only the reply's author may delete it (Decile admins may delete any reply), and the acting user must still be able to see the parent post.
Action
Delete a direct prospect attachmentDeletes one direct attachment (`source: "direct"`) by its `id` from
Action
Delete a document from an Investment Committee checklist itemDeletes one checklist document by its attachment `id`. By default
Action
Delete a draft newsletterDeletes a newsletter that is not published, with its content and
Action
Delete a due diligence task from a Deal MemoRemoves one task from the memo's Diligence tab checklist, with any
Action
Delete a message from a Task threadRemoves a message from the Task's thread. Only its author (or a Decile admin) can delete it. Message ids are in get_task `data.notes`.
Action
Delete an email templateDeletes an email template, as deleting it in the app does. This
Action
Delete a note from an organizationDeletes one note from an organization by note ID. Note IDs come from a read with
Action
Delete a note from a personDeletes one note from a person by note ID. Note IDs come from a read with
Action
Delete a note from a pipeline prospectDeletes one note from a pipeline prospect by note ID. The note is located exactly where
Action
Delete a step of a prospect's sequenceDeletes one step, the same as deleting it in the app. Deleting a task
Action
Delete a variablePermanently deletes a variable from the Variables page. Account
Action
Delete EventDelete an Event and all associated data including pipeline and questionnaire.
Action
Delete FileRecoverably deletes a Data Room file and removes all its folder placements
Action
Delete FolderRecoverably deletes a folder with all its subfolders and files. Call preview_delete_folder first to see what it removes and whether it can be deleted. Folders linked to a record, system-managed folders, and folders holding a Schedule K-1 document of record cannot be deleted.
Action
Delete Organization by IDPermanently deletes the directory organization selected by account-scoped ID, as the directory's
Action
Delete Person by IDPermanently deletes the person selected by account-scoped ID.
Action
Deletes a pipelinePermanently deletes a user-created pipeline with its stages, automations and prospects, as deleting it in Hub does. Cannot be undone; archive the pipeline to only hide it.
Action
Deletes a pipeline stagePermanently deletes a stage. Account admin authorization is required (account admins, or decile admins acting on the account). The delete cannot be undone.
Action
Deletes a pipeline stage actionDeletes an action, all of its sub-actions, and every execution of them on prospects, pending and finished, as deleting it in the app does. This cannot be undone. Account admin authorization is required. Deleting a sub-action updates its parent's `wait_days` and `automate` from the remaining first su
Action
Disconnect a Deals Agent sourceDisconnects one of the user's sources, as Disconnect in the Deals
Action
Dismiss a brief itemDismisses one item from the "needs attention" brief, as the dismiss
Action
Draft a Fund News post for a fund's LPsCreates a draft; nothing reaches LPs until `publish_fund_news_post`.
Action
Draft a gate list from the fund thesisAsks Hub to draft a gate list for the fund behind an investment pipeline from its thesis, tags and deal history. Drafting runs in the background (202); the drafts then appear in list_deal_gates with status draft, each with a rationale, and stay inert until a person turns them on. New drafts REPLACE
Action
Edit a Decile Base postEdits a Base post's content, title, or both; fields left out keep their value. `content` is parsed as Markdown, and its `@FirstName` and `@FirstName LastName` mentions resolve as they do on create. Only the post's author may edit it (Decile admins may edit any post), and the acting user must still b
Action
Edit a Decile Base replyReplaces a Base reply's content. `content` is parsed as Markdown, and its `@FirstName` and `@FirstName LastName` mentions resolve as they do on create. Only the reply's author may edit it (Decile admins may edit any reply), and the acting user must still be able to see the parent post.
Action
Edit a draft Fund News postOnly the fields passed change: an omitted `company_id` keeps the
Action
Edit a step of a prospect's sequenceEdits one unfinished step, the same as the step's edit form in the
Action
Email a draft Venture Partner Agreement to the Venture Partner forSends a draft agreement to the Venture Partner, as the Hub "Send to
Action
Email the signing link to the Venture Partner againEmails an unsigned agreement's signing link to the Venture Partner
Action
Every LP of a fund and where each stands on a commitment increaseLists every limited partner of the fund with where each stands on a
Action
Every LP of a fund and where each stands on a withdrawalLists every limited partner of the fund with where each stands on a
Action
Execute a single pipeline action executionExecutes one `PipelineActionExecution` for the prospect — sends the
Action
File a Decile support ticketFiles a support ticket in the support tickets channel, with the filer subscribed to the thread — the same intake the in-app Get help form uses. A Decile admin's own ticket files into the staff-only [Group] Internal Support Queue instead, with no confirmation email. The ticket is always attributed to
Action
Find EventGets a paginated list of Events in your account. The response will have a data array with the events and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Events returned can be filtered and ordered. Order direction is asce
Action
Find links to Hub pagesReturns the link and the left-nav path for Hub pages that are not one record, such as the events list, the people directory, tasks, files, newsletters, deal memos, deal memo settings, entity management, settings, the team, API & MCP (API keys and the AI connector), the Agents page (Dex skills) or th
Action
Follow or unfollow a Base channel, post or replyFollows a Base channel, post or reply as the user who owns the API key — the same as the Follow button in Base. Pass exactly one of `base_channel_id`, `base_post_id` or `base_reply_id`. Set `remove` to true to unfollow. Both directions are idempotent. The acting user must be able to see what they fo
Action
Fund-level capital summaryFund-level capital figures for one entity, summed across its capital
Action
Generate a financial reportQueues an asynchronous financial report generation job. The job includes every entity of the requested `entity_type` within the API key's account. Use the returned `status_url` to poll job status and download generated files after the job succeeds.
Action
Get an Agreement Reviewer question and its answerOne of your questions: status pending, answered or failed; the answer in markdown when answered; and whether a failed question can be retried.
Action
Get a pitch deckA pitch deck Dex drafted in one of your chats, as the deck card shows it: the fund
Action
Get a published newsletter's delivery reportThe same figures as the newsletter's Delivery report, plus the
Action
Get a scheduled taskOne scheduled task with its next run and its 10 most recent runs,
Action
Get a single activity entry with its full entryable bodyReturns one activity entry plus the full per-type `entryable` body —
Action
Get a single Deal Memo by idReturns the full deal memo payload (organization, counterfactual,
Action
Get a single deal share owned by the current accountReturns one deal share submitted by the caller's account, with the full
Action
Get a single portfolio company by idReturns one portfolio company — the same allowlisted fields surfaced by
Action
Get a single portfolio company investmentReturns a single investment tranche (accounting-transaction-driven) on a portfolio
Action
Get Deal Memo ratingsRead a deal memo's ratings: the rating categories from the memo's config, in order; the scale (1 to 5, with 3 deliberately not allowed); the overall average_score; per-category averages (null until someone scores the category); every rater's scores, per-category comments and note; and my_rating, the
Action
Get Event analyticsReturn bounded aggregate metrics for one Event. Page views count distinct tracking rows in both legacy and current formats and are zero for an unpublished Event. Guestlist and attended count current kept prospects in those exact pipeline stages. Invited counts current kept prospects in the Invited,
Action
Get Event GuestsGet a paginated list of guests for an event with their RSVP status and pipeline stage information. Results can be filtered by email or pipeline stage.
Action
Get Event settingsGet the account defaults used for new Events.
Action
Get financial report generation statusReturns the current status for a financial report generation job created by the authenticated API key. Successful jobs include download URLs for the generated files.
Action
Get one deal share from the Opportunities feedReturns one deal share from the Opportunities feed by id (from `list_deal_feed`),
Action
Get one imported bank transactionRead-only lookup using the same privacy-safe allowlist as the list
Action
Gets one scheduled emailReturns one scheduled email with its recipient (`to`) and the HTML message that will send (`body`). Data room links show unpersonalized; they are personalized for the recipient at send time. Requires access to the pipeline. An email that has sent or was cancelled returns 404.
Action
Get TaskReturns a single account-scoped Task by id, with its message thread (`data.notes`, oldest first).
Action
Get the Deals Agent setupWhat the Deals Agent Configure window shows: the sources the agent
Action
Get the needs-attention briefThe "needs attention" brief for the current user: the same ranked
Action
Invite a person to a data roomInvites a person to the room by email, as the room's Access tab does.
Action
Invite a teammateInvites someone to join the account, as the Team page's Invite Teammate
Action
Leave recipients out of a draft newsletter, or include them againSame as unticking or ticking people in a draft newsletter's
Action
Link a data room file onto an upload TaskLinks an existing data room file onto an open upload Task (idempotent — re-linking the same file succeeds without duplicating). Linked files count toward the task's required file minimum (min_files) alongside uploaded documents, so a task needing several files can mix uploads and links. Only the tas
Action
Link a person to an organizationLinks a person to an organization. Send `person_id` to link an existing person, or an email and/or name to find the person by email or create them. The person becomes the primary contact if the organization has none. Linking a person who is already linked returns the existing link with 200. Needs an
Action
Link a portfolio position to the Deal Memo that funded itLinks a portfolio position the fund already holds to this memo,
Action
Link organization files into a Deal MemoLinks files that already exist on the memo's organization into the
Action
List accessible Decile Base channelsLists Base channels the authenticated user can see. Available to any API key with Base access. Returns the user's accessible question and conversation channels.
Action
List activity feed entries for the current accountReturns the activity feed for the current account, newest first. Filter by
Action
List a Deal Memo's due diligence tasksLists the due diligence tasks of a deal memo, the checklist on the
Action
List a Deal Memo's Investment Committee checklistLists the memo's Investment Committee checklist items: the documents
Action
List a Deal Memo's materials, term sheets and linked filesLists the files on the memo's Materials tab: memo materials
Action
List a Deal Memo's questions with their current answersReturns the memo's question template grouped by category in the order
Action
List a fund's Fund News postsThe updates a fund's managers publish to its LPs on Decile Pro,
Action
List a fund's manager estimatesThe fund manager's own, unofficial value for each position, as
Action
List a newsletter's recipients, including those left outThe newsletter's recipient list: everyone its recipient groups
Action
List a prospect's filesLists the files available for a pipeline prospect, merged from two
Action
List a prospect's pipeline action executionsLists the `PipelineActionExecution` rows for a single prospect — i.e. the
Action
List a structured Schedule of InvestmentsReturns the same canonical Schedule of Investments calculations used by
Action
List capital accounts under an entityIdentity-plus-commitments list. Each row is the shared identity
Action
List capital calls under an entityReturns the capital calls (draft/open/closed) issued from the given
Action
List custom emoji and search the Base emoji pickerLists the emoji `set_base_reaction` accepts beyond plain Unicode. With no `query`, returns every workspace custom emoji and no standard ones. With a `query`, filters custom emoji by name and searches the standard emoji in the Base picker by name and keyword (at most 50). Available to any API key wit
Action
List Deal Memo commentsList the comments on a deal memo, oldest first. Comments are the memo's review thread: the team's notes, meeting takeaways and email context about the deal. Each entry carries the author and the plain-text content.
Action
List deal memos for the current accountReturns a paginated list of deal memos belonging to the caller's
Action
List Decile Base inbox itemsReturns the authenticated user's Decile Base inbox — a paginated, time-ordered feed of posts and replies they are subscribed to or mentioned in. Available to any API key with Base access. When `channel_id` is supplied, the API key's user must have access to that channel.
Action
List Decile Research InvestorsLists the shared "Decile Research" LP roster. The same roster is
Action
List Decile support ticketsLists support tickets. Support staff — members of the support tickets channel, plus Decile admins — get the triage queue with the same filters as the staff queue page, starred first; a non-admin does not see another ticketing channel's tickets (the internal support queue's) unless they are a member
Action
List duplicate PeoplePeople who share a name with another person in the directory, as the directory's duplicate
Action
List each fund's thesis industries and the allowed valuesLists the account's funds with their thesis industries, the allowed industry
Action
List email templates for the accountReturns the email templates of the pipelines the token's user may
Action
List FilesGets a paginated list of Files in your Files. The response will have a data array with the files and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Files returned can be filtered and ordered. Order direction is ascending
Action
List File VersionsLists a data room file's versions, newest first, as the file preview shows them. Each version has its placement id, label (v1, v2...), name, upload time, whether it is the latest, and whether it is the one asked for.
Action
List financial report generation jobsReturns a paginated list of financial report generation jobs that belong to the authenticated API key's account, regardless of which API key within that account created them. Sorted by `created_at` descending. Successful jobs include download URLs for the generated files.
Action
List firm-admin entitiesReturns a paginated list of the firm-admin entities (funds, SPVs,
Action
List firm variablesReturns the variable picker for a pipeline + the authenticated
Action
List FoldersGets a paginated list of Folders in your Files. The response will have a data array with the folders and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Folders returned can be filtered and ordered. Order direction is asc
Action
List imported bank transactions under an entityRead-only discovery of imported bank transactions. The privacy-safe
Action
List investments for a portfolio companyReturns the investments (accounting-transaction-driven tranches) belonging
Action
List journal entries under an entityReturns the journal entries (general-ledger / accounting transactions —
Action
List OrganizationsGets a paginated list of Organizations in your Organizations Directory. The response will have a data array with the organizations and a pagination object with the total count, current page, and total pages.Pages are 0-indexed, so the first page is page 0.The Organizations returned can be filtered a
Action
List pending teammate invitationsReturns the pending teammate invitations on the account, as the Team
Action
List PeopleGets a paginated list of People in your People Directory. The response will have a data array with the people and a pagination object with the total count, current page, and total pages.Pages are 0-indexed, so the first page is page 0.The People returned can be filtered and ordered. Order direction
Action
List per-LP detail rows under a capital callReturns the per-capital-account line items (LPs/GPs) attached to a
Action
List Pipeline ProspectsGets a paginated list of Prospects in a Pipeline. The response has a
Action
List pipelines for the current accountReturns the active pipelines for the current account. Pass
Action
List portfolio companies for the current accountReturns portfolio companies across every fund in the current account.
Action
List posts in a Decile Base channelLists posts in a single Base channel, most-recent-first, with pagination. Available to any API key with Base access; the acting user must also be authorized for the channel. Posts whose author chose to remain anonymous are returned with a neutral author ("Community Member"); the real user id, name,
Action
Lists a pipeline's scheduled emailsReturns the pipeline's scheduled emails whose send time is still ahead, soonest first. This is the list the pipeline's Scheduled emails panel shows, and it includes emails scheduled with `send_email`. Requires access to the pipeline.
Action
List scheduled tasksThe account's scheduled tasks (recurring agent runs), as the
Action
List signed PACTsLists signed PACTs (pledge agreements capturing an investor's soft
Action
Lists the stage actions configured on a pipelineReturns every automation action on every stage of the pipeline, with its full config, so callers can audit automations and find broken references. Account admin authorization is required.
Action
Lists the stages of a pipelineReturns every stage of the pipeline in board order, with the id needed to rename a stage or to filter prospects by stage. `internal_id` is the stable key automations match on and never changes when a stage is renamed; `editable: false` marks a Decile-Hub-managed stage that cannot be renamed.
Action
List TasksReturns a paginated, account-scoped list of Tasks. Optional filters narrow by status, assignee, and origin. Pages are 0-indexed.
Action
List the account's newslettersNewest first, in the standard `{data, pagination}` envelope.
Action
List the AccountUsers on the current accountReturns the AccountUsers belonging to the authenticated API key's account.
Action
List the chart of accounts / GL account codesReturns the chart of accounts (GL account codes) shared across the
Action
List the deal gates of a pipeline's fundThe gates (plain-English yes/no screening questions) of the fund behind an investment pipeline, in every status (draft, active, off), in position order. Needs read access to the pipeline. Deal gates are rolled out per account: while they are off for the account, a caller who may use the pipeline get
Action
List the deal shares submitted by the current accountReturns the deal shares the caller's account has submitted into the network feed.
Action
List the Opportunities feed of deals shared by every fundReturns the Opportunities feed: the deal shares every fund in the Decile network
Action
List the people linked to an organizationLists the people linked to an organization, oldest link first, with each person's title at the organization and whether they are its primary contact. Needs an account admin or the directory role (403 otherwise).
Action
List the portfolio positions that can be linked to a Deal MemoLists the portfolio positions.
Action
List the positions a manager estimate can be recorded onThe fund's positions, by company, with what Hub's estimate form
Action
List valuation history for a portfolio companyReturns valuation events for one portfolio company, ordered by valuation
Action
List your Dex chatsReturns your own chats with Dex and other assistants in the active account, newest first, as the chat sidebar lists them. Pinned chats come back in `pinned` on the first page. Pages hold 40 chats and are 0-indexed.
Action
LPs' Schedule K-1 status, for one fund, SPV or holding entity orEach LP's Schedule K-1 status for one tax year, as Hub records it.
Action
Makes a pipeline the primary pipeline of its typeMakes the pipeline the one the left navigation links to for its type, as "Make this the primary pipeline" on its Settings page does. The previous primary pipeline stops being primary.
Action
Mark a pending step of a prospect's sequence as done outside HubMarks one pending step as done without running it, for work done
Action
Mark Decile Base inbox threads read or unreadMarks the authenticated user's Base inbox threads read or unread, by post ID (`post_ids`, 1 to 200), or marks the whole inbox read, direct messages included, with `all` set to true and no `post_ids`. Send one of the two. Posts the user cannot see are skipped; `post_ids` in the response lists the pos
Action
Merge duplicate OrganizationsMerge duplicate organizations into one, as the directory's Merge does. Everything on the organizations in organization_ids (people, deal memos, pipeline deals, portfolio companies, notes, files, activity, tags) moves to survivor_id, and those organizations are then deleted. This cannot be undone. Th
Action
Merge duplicate PeopleMerge duplicate people into one, as the directory's Merge does. Everything on the people in
Action
Move a prospect to another pipelineMoves a prospect to another pipeline of the same account, as the prospect's Move to Pipeline
Action
Move Folders and FilesMoves folders and files into another folder. Items that cannot leave an internal-only folder are skipped and counted in failed. A selection that breaks a rule (system-managed folders, a destination inside a moved folder, items already in the destination) is refused and nothing moves.
Action
Notify the investment lead of Investment Committee feedbackInvestment Committee only (Decile Group reviewers). The stage moves to
Action
Nudge Task assigneeReminds the assignee of an open Task by sending the assignment notification again. Permitted for the task creator, the owner of the task account, and account admins. Returns 422 when the task is closed.
Action
One LP's side letter and the fund terms it is offered againstReturns `side_letter` — the LP's live (not withdrawn) side letter, or
Action
One Venture Partner AgreementReturns one Venture Partner Agreement with its stage, terms, dates and
Action
Open the Agreement ReviewerThe Decile agreements you can review, the full text of one agreement (the first unless `template` names another) with its sample questions, and your current conversation on it: up to the last 10 questions, oldest first, with their answers. Available to Decile staff and members of the account; others
Action
Opportunities feed access status and how the feed worksStart here for Opportunities, the Decile network feed where funds share deals with
Action
Pauses automation on a pipelinePauses every automation on the pipeline, the same as "Pause Automation" in Hub. While paused, stage actions (emails, sequence steps and other automated actions) do not run for any prospect on the pipeline.
Action
Pin a Dex chatPins one of your chats to the top of the chat sidebar.
Action
Pipeline metrics: current state + 7-day-ago snapshotReturns aggregate counts/values for a pipeline plus a 7-days-ago
Action
Postpone a prospect's sequencePostpones the prospect's whole sequence, the same as "Postpone" in the
Action
Pre-approve a Deal MemoInvestment Committee only (Decile Group reviewers). The stage moves to
Action
Prepare an LPA email for the user to edit, then send it withPrepares the LPA email for a Person so the user can edit it before it goes out. It sets the Person up to sign (closing pipeline, capital account, optional commitment amount) and returns the draft; nothing is sent. Show the user `email` (the same shape `preview_email` returns), then call `send_email`
Action
Preview a pending send_email action executionRenders the would-be sent email for a pending `send_email`
Action
Preview a templated or freeform email before sendingResolves the target recipient, renders the chosen template (or
Action
Preview Folder DeleteShows what deleting a folder would remove, without deleting anything. Returns the number of files and subfolders the delete would take, a message to show the user, and whether the folder can be deleted.
Action
Publish a draft Fund News post to the fund's LPsShows the post to the fund's LPs on Decile Pro. **Requires
Action
Publish a manager estimate to the fund's LPsShows the estimate to the fund's LPs on Decile Pro, where the fund's
Action
Publish a newsletter to its full audienceSends the newsletter to every calculated recipient, or schedules
Action
Rate a Deal MemoRate a deal memo as the API key's user: one score per rating category, optional per-category comments and an overall note. Category names come from the memo's config (read them with get_deal_memo_ratings). Scores are 1, 2, 4 or 5; 3 is deliberately not allowed so the scale polarizes feedback, and nu
Action
Read a Dex chatReturns one of your chats with its latest 200 messages in the order the chat shows them. Each tool step is named and summarised as its card in the chat. An assistant message whose `run_status` is `pending` or `running` is still being written, unless `awaiting_input` is true; then Dex waits on `pendi
Action
Read who can open a data roomWho can open a data room, as the room's Access tab shows it.
Action
Re-answer the gates for one dealRe-answers every active gate for one deal (pipeline prospect) in the background (202). Read the answers afterwards with list_pipeline_prospects include=gates. Needs edit access to the deal's pipeline. Deal gates are rolled out per account: while they are off for the account, a caller who may use the
Action
Record a completed task for a prospectLogs a task as done, the same as "Record completed task" in the app.
Action
Record a manager estimate for a positionRecords the fund manager's own, unofficial value for one position.
Action
Remove a contact from a capital accountTakes the contact off the capital account; the Person record is kept.
Action
Remove an Event guestRemove a guest and their RSVP from an Event.
Action
Remove a scheduled deal pullRemoves a scheduled deal pull, as its remove button in the Deals
Action
Remove a scheduled taskRemoves a scheduled task, as its remove button does. The task stops
Action
Remove a teammate from the accountRemoves a teammate from the account, as the Team page does. They lose
Action
Remove Folder Visitor AutomationRemoves every visitor automation from a folder and everything in it. Needs edit access to the folder.
Action
Remove one prospect from its pipelineRemoves a prospect from its pipeline by id. This is a RECOVERABLE soft
Action
Rename a Dex chatRenames one of your chats, as renaming it in the chat sidebar does. A blank name shows the chat as Untitled.
Action
Rename FolderRenames a folder. Folder names must be unique within the same parent. System-managed folders cannot be renamed.
Action
Renames a pipeline stageChanges a stage's display name. Account admin authorization is required (account admins, or decile admins acting on the account).
Action
Render a newsletter and evaluate the publish gate without sendingRenders the newsletter exactly as it will be mailed and returns
Action
Reopen a closed Deal MemoReopen a closed deal memo: it moves back to active and its ending (close type, reasons and note) is cleared. Needs the same permission as editing the memo. Only a closed memo can be reopened (422 validation_failed otherwise); a memo in review is taken back with unsubmit_deal_memo.
Action
Reorders the stages of a pipelineSets the board order of a pipeline's stages. Account admin authorization is required (account admins, or decile admins acting on the account).
Action
Replace one fund's thesis industriesReplaces one fund's thesis industries, which drive the Opportunities feed stage
Action
Resend an Event inviteSend the Event invite email to one guest again. A guest still on the guest list moves to Invited, which sends the invite unless it is set to Manual.
Action
Restore an archived Dex chatRestores one of your archived chats to the chat sidebar.
Action
Resumes automation on a pipelineResumes automation on the pipeline, the same as "Resume Automation" in Hub. Stage actions run again, and prospects whose fund admission waited on the pause continue.
Action
Retrieve a message you sentRetrieve a message you sent while you still belong to its private conversation. Only messages you sent are available; there is no conversation history. Retrieving a message does not mark it read or reopen the conversation.
Action
Retrieve a single email templateReturns the full template — index fields plus rendered (HTML)
Action
Retrieves info for a specific pipelineReturns basic information for a specific pipeline and its stages.
Action
Retry a failed Agreement Reviewer questionAsks a failed question again (up to 3 tries in all). For a question about an uploaded document, send its text again in upload_text. Counts toward your hourly limit; poll get_agreement_review_question for the answer.
Action
Revoke a pending teammate invitationRevokes a pending invitation, as the Team page does. The link in the
Action
Run a scheduled task nowRuns a scheduled task now, as its "Run now" button does: one agent
Action
Save CSV To FolderSerializes a structured `{headers, rows}` payload into a CSV file
Action
Search files linkable onto an upload TaskReturns up to 20 recent data room files (newest first) the caller may read in the task's account, optionally filtered by file name. Only the task assignee (or a Decile admin) may search. Link a result with link_file (folder_file_id) as an alternative to uploading a new document. Pass file_id to crea
Action
Search people and organizations by name, email, or company fragmentCombined lookup across the caller account's People and Organizations —
Action
Search pipeline prospects by name or emailProspect lookup that answers "is <name> in my pipeline?", "find the
Action
Send a Deal Memo back from the Investment CommitteeInvestment Committee only (Decile Group reviewers). Sends a memo that
Action
Send an LPA email to a PersonSends the standard LPA email to the Person at once, with no chance to edit it. It sets the Person up to sign first (closing pipeline, capital account, optional commitment amount). To let the user edit the email first, use `draft_lpa_email` instead, then send with `send_email`. `pipeline_id` is requi
Action
Send a PACT email to a PersonMirrors the UI "Send PACT" button. Adds or moves the Person onto the investor pipeline's Send PACT stage, finds the configured PACT email template, and sends it. `pipeline_id` is required only when the account has more than one investor pipeline.
Action
Send a private messageSend a private message as yourself in a conversation with one other person. Markdown is supported; the response contains plain text. Reuse the same client_uuid and message text when retrying to avoid duplicates and receive the original message ID. Reusing a UUID for different text returns 409 idempo
Action
Send a test copy of the newsletter to literal addressesDelivers a test copy to `test_email_to_addresses` only. The
Action
Send Event invitationsQueue invitations for Event guests who are waiting to be invited.
Action
Send the LP's withdrawal agreement to the LP for signatureSends this LP's withdrawal agreement to the LP, as the Hub "Send to LP"
Action
Set Folder Visitor AutomationSets the visitor automation on a folder and everything in it, as on the room Settings tab. An identified visitor who opens the folder or views or downloads a file in it is added to the chosen pipeline stage, or moved up to it. Replaces any existing automation. Needs edit access to the folder.
Action
Show a Decile Base postReturns a single Base post with its full thread of replies (ordered by creation time). Available to any API key with Base access; the acting user must also be authorized to view the post.
Action
Show a single variableReturns a single variable from the pipeline's picker for the
Action
Show EventGet a single Event by ID or unique_event_id. The default response contains the full editable Event contract, its hosts, and email_templates (each Event email with its template id and sending: automatic or manual; left out when fields= is given). The optional include= replaces the default host includ
Action
Show FileGets details for a specific file, including metadata and associated folders. Each data_room_folder_files entry includes id, folder_id, version_group_id (stable across byte replacements) and new_version_id (the next placement ID, not a file ID). Historical file IDs remain readable. List files with fo
Action
Show FolderGets details for a specific folder, including optional child folders and files. Use the contents parameter to specify what to include: "folders", "files", or "folders,files". Default includes both folders and files.
Action
Show one capital accountIdentity block + commitments + primary_contact + contacts + entity
Action
Show one capital callReturns the header block for a single capital call. Use
Action
Show one chart-of-accounts / GL account codeReturns a single chart-of-accounts entry (GL account code) by its
Action
Show one firm-admin entityReturns identity + a `details` block for one entity. The `details`
Action
Show one journal entryReturns a single journal entry (general-ledger / accounting transaction —
Action
Show OrganizationGet a single Organization by id. The default response shape is unchanged from prior versions (embeds notes, people, submit_your_company_response_data). The optional include= and fields= parameters are purely opt-in - include= replaces the default include set with a caller-specified subset, and field
Action
Show PersonGet a single Person by Person id. A pipeline prospect id is not a Person id: take `person_id` from a search_pipeline_prospects row. An unknown id returns 404. The default response shape is unchanged from prior versions (embeds notes, organizations_with_titles, referred_by). The optional include= and
Action
Single-capital-account period calculationsComputes a single capital account's period figures. Response groups:
Action
Skip a pending step of a prospect's sequenceSkips one pending step, the same as the skip button in the app. The
Action
Snooze Task remindersSnooze the daily digest and due-date reminders for a Task assigned to you. 0 days turns them off until you turn them back on. Comments, reassignment and nudges still notify.
Action
Star Data Room ItemStars a folder or file for the caller, so it shows under Starred. Starring twice is a no-op.
Action
Start a new conversation on an agreementYour earlier questions on the agreement leave the conversation get_agreement_review shows. It does not change your hourly question limit.
Action
Start a side letter for one LPOffers this LP a side letter: records the negotiated carry, writes the
Action
Start a Venture Partner Agreement as a draftStarts a Venture Partner Agreement for the fund's GP as a draft, as
Action
Start or reuse a private conversationStart or reuse a private conversation with one person. Returns the conversation ID and member IDs. Reusing a conversation preserves its name and read or closed state.
Action
Start withdrawing one LP from their fundStarts withdrawing this LP, as the Hub "Withdraw LP" button does: the
Action
Submit a Deal Memo for reviewSubmit a deal memo for review by Decile Hub. Requires the account to have the Deal Memo Review product enabled (returns 422 otherwise). Optionally attach a submission comment via `submission_comment.content`.
Action
Submit a Deal Memo to the Investment CommitteeSends the memo to the Investment Committee, as the investment lead does
Action
Submit a non-compliant-wire compliance-review decisionApplies only to a non-compliant-wire compliance-review Task created by
Action
Take a person's access to a data room awayRemoves the person from the room's invited list and turns off their
Action
Turn on several deal gatesTurns on several gates of the fund behind an investment pipeline at once, typically the drafts from draft_deal_gates after the user has agreed to them. Hub then answers every active gate for every open deal in one pass that starts right away. Gates already on are left as they are. Turning a gate on
Action
Turn Task reminders back onTurn the daily digest and due-date reminders back on for a Task assigned to you.
Action
Unlink a data room file from an upload TaskRemoves a previously linked data room file from an open upload Task (idempotent — unlinking a file that is not linked succeeds). Only the task assignee (or a Decile admin) may unlink.
Action
Unlink a person from an organizationUnlinks a person from an organization. The person record is kept. If the person was the primary contact, another linked person becomes the primary contact. Confirm the person with the user first. Needs an account admin or the directory role (403 otherwise).
Action
Unpin a Dex chatUnpins one of your chats.
Action
Unpublish a manager estimateLPs stop seeing the estimate, and it can be edited again. The
Action
Unstar Data Room ItemRemoves the caller's star from a folder or file. Unstarring an item without a star is a no-op.
Action
Unsubmit a Deal Memo from reviewTake a deal memo back from Decile Group review: the memo moves from review to active, so it can be edited, submitted again or deleted. Needs the same permission as deleting the memo. Only a memo in review can be unsubmitted; once it is with the Investment Committee only Decile Group sends it back (4
Action
Update a deal gateChanges one gate of the fund behind an investment pipeline: its wording, label, must_pass, binding, position or status (`off` keeps the gate but stops answering it). Fields left out keep their value; a gate bound to a field keeps its binding unless `field_binding` is sent. Editing the question or th
Action
Update a Decile support ticketMoves a ticket's stage, assigns or unassigns it, or advances its priority star. Support staff only — members of the support tickets channel, plus Decile admins. `stage` is a stage key (added, acknowledged, actioned, in_progress, complete, not_planned) or its name (e.g. "In Progress", "Not Planned").
Action
Update a due diligence task on a Deal MemoChanges the title, description, status or response of one task on the
Action
Update a firm-admin entityUpdates writable fields on an existing entity within the authenticated
Action
Update an email templatePartial update: only the keys you send are touched. Read the current
Action
Update an Event guestChange the pipeline, RSVP, or attendance state for an Event guest.
Action
Update a note on an organizationRewrite the body (and optionally the context) of an existing note on an organization, as editing
Action
Update a note on a personRewrite the body (and optionally the context) of an existing note on a person, as editing
Action
Update a note on a pipeline prospectRewrite the body (and optionally the context) of an existing note on a pipeline
Action
Update a variableChanges a variable on the Variables page. Account admin
Action
Update EventUpdate an existing Event. Only the provided fields will be updated. Events start public: send access_type=private_access ONLY when the user asks for a private or password-protected Event. After making one private, read the registration_code from the response back to the user - that code is the Event
Action
Update Event email sendingSet how an Event email is sent - automatic (Hub sends it) or manual (it waits for the host on the guest list). get_event lists the Event emails with their template id and current sending. Going automatic while guests already wait for the email returns 422 confirmation_required with the waiting_guest
Action
Update Event RSVPUpdate a guest's RSVP status for an event. This will also update the guest's pipeline stage accordingly.
Action
Update Event RSVP rolesSet the role choices guests pick from when they register for an Event, or turn the role question off. Leave a field out to keep its current value.
Action
Update Event settingsUpdate the account defaults used for new Events.
Action
Update one pipeline prospectSame fields as the batch `.
Action
Update Organization by IDUpdates the existing organization selected by account-scoped ID; changing its name does not create a record.
Action
Update Organizations by IDUpdates up to 100 organizations by account-scoped ID and returns per-item updated and errors arrays. Requests with more than 100 items are rejected before any update runs. Remote logo URLs are fetched sequentially; omit logos or split image-heavy updates into smaller batches.
Action
Update People by IDUpdates up to 100 people by account-scoped ID and returns per-item updated and errors arrays. Requests with more than 100 items are rejected before any update runs. Remote picture URLs are fetched sequentially; omit pictures or split image-heavy updates into smaller batches.
Action
Update Person by IDUpdates the existing person selected by account-scoped ID; changing the email does not create a record.
Action
Update ProspectsUpdates one or more prospects in a pipeline. Send `pipeline_id` (query or body) and a JSON array `prospects`.
Action
Updates a pipeline's settingsChanges the fields of the pipeline's Settings page. Send only the fields to change. A field the pipeline does not offer is refused with 422 `field_not_editable` and nothing changes.
Action
Update TaskUpdates a Task's title, description, assignee, due date, or status. Permitted for the task creator, current assignee, account owners/admins, and Decile admins. New assignees must be members of the task account. Only Decile admins can reassign tasks to Decile admins.
Action
Void a Venture Partner Agreement before it is executedVoids the agreement, as the Hub "Void" button does: it can no longer
Action
Void the LP's withdrawal before the LP signsVoids this LP's withdrawal in progress, as the Hub "Void" button does:
Action
What a fund's LPs see on Decile ProThe LP Portal sharing level (`light`, `medium`, `heavy` or
Action
Where one LP stands on a commitment increaseReturns `commitment_increase`: where this LP stands on increasing their
Action
Where one LP stands on a withdrawalReturns `lp_withdrawal`: where this LP stands on withdrawing from their
Action
Withdraw an LP's outstanding side letterTakes the offer back before legal ops approve it: the questionnaire
Action
Write or replace answers to a Deal Memo's questionsWrites or replaces the answers to one or more of the memo's questions in
Action
Add Blocked Phone NumbersAdds 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 IdAdds 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 ChannelAdds 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 SubscriptionCreates 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 EndpointCreates 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 FileCreates 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 EntryThe 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 RecordCreates 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 PostCreates 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 EndpointCreates 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 SubscriptionCreates 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 AssignCreates 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 EndpointCreates 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdRemoves 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 IdDeletes 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 ResourceDeletes 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 DepartmentRemoves 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdDeletes 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 IdCloses 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 IvrsRetrieves 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 IdRetrieves 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 ReportsRetrieves 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 IdRetrieves 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 NumbersThe 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 OfficeRetrieves 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 LabelsRetrieves 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 DetailsRetrieves 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 IdRetrieves 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 IdRetrieves 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 IdRetrieves 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 RoomsRetrieves 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 CentersRetrieves 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 DetailsRetrieves 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 ListRetrieves 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 IdRetrieves 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 IdRetrieves 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 DetailsRetrieves 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 InformationRetrieves 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 ApiRetrieves 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 EndpointRetrieves 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 UsersRetrieves 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 IdUpdates 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 ConfigurationUpdates 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 OfficeUpdates 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 IdUpdates 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 EndpointUpdates 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 StatusUpdates 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 SecretUpdates 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 SubscriptionCreates 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 EventCreates 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 SecretCreates 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 NumbersRemoves 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 SubscriptionRetrieves 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 SettingsRetrieves 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 DetailsRetrieves 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 NumbersRetrieves 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 InformationRetrieves 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 InformationRetrieves 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 IdRetrieves 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 IdRetrieves 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 V2The 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 InformationRetrieves 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 DataRetrieves 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 IdRetrieves 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 ListRetrieves 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 IdRetrieves 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 IdRetrieves 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 DetailsRetrieves 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 DepartmentsRetrieves 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 V2Retrieves 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 IdRetrieves 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 IdRetrieves 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 IdRetrieves 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 StatusRetrieves 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 IdRetrieves 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 IdRetrieves 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 IdRetrieves 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 IdRetrieves 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 SubscriptionsRetrieves 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 IdRetrieves 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 IdRetrieves 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 LogRetrieves 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 IdRetrieves 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 ContactsRetrieves 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 IdRetrieves 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 ListRetrieves 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 IdRetrieves 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 IdRetrieves 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 ConnectionRetrieves 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 IdSets 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 EventCreates 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 StatusThe 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 IdUpdates 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 InformationUpdates 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 IdUpdates 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 OfficeThis 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 UserUpdates 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 DetailsUpdates 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 SettingsThe 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 SettingsUpdates 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 IdThis 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.
Each app on its own
Reviews
What our customers say
More from Decile Hub
Decile Hub to HubSpotHubSpot is your all-in-one stop for all of your marketing software needs.
Decile Hub to SalesforceSalesforce is a leading enterprise customer relationship management (CRM) platform.
Decile Hub to SlackSlack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...
Decile Hub to Google SheetsGoogle Sheets is Google's online spreadsheet app for creating, editing and sharing spreadsheets.
Decile Hub to GmailGmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...
Decile Hub to Google CalendarGoogle Calendar is a time management tool providing scheduling features, event reminders, and integration...
More into Dialpad
HubSpot to DialpadHubSpot is your all-in-one stop for all of your marketing software needs.
Salesforce to DialpadSalesforce is a leading enterprise customer relationship management (CRM) platform.
Slack to DialpadSlack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...
Google Sheets to DialpadGoogle Sheets is Google's online spreadsheet app for creating, editing and sharing spreadsheets.
Gmail to DialpadGmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...
Google Calendar to DialpadGoogle Calendar is a time management tool providing scheduling features, event reminders, and integration...
Questions
Decile Hub and Dialpad, answered
What can start an automation from Decile Hub?
Any of Decile Hub's 5 triggers in the catalog, including New Event, New Organization, New Person and New Task. Describe the moment in plain language and your agent picks the right one.
What can your agent do in Dialpad when something happens in Decile Hub?
Any of Dialpad's 110 actions, including Create Agent Status Subscription, Create Channel Endpoint, Create Custom Ivr With Audio File and Create New Contact Entry. Your agent maps the data both ways and tests every scenario before it ships.
Can it also run from Dialpad to Decile Hub?
Dialpad has no triggers in the catalog today, so automations start in Decile Hub. If you need the other direction, ask: your agent reads Dialpad's API documentation and adds it.
Do I have to build a connector for Decile Hub or Dialpad?
No. Both are in the catalog with their triggers and actions. You describe the automation; your agent builds it, tests every scenario and keeps it running.
Can my AI client use Decile Hub and Dialpad without building an automation?
Yes. With your AI client connected to APIANT, ask it to do something in either app once and it runs that action on the spot. Ask for an automation and your agent builds it, tests every scenario and keeps it running. One connection covers both.
What happens when something fails?
Your agent works that out for you. It plans the failure paths along with the happy path, then tests every scenario before it ships.
Is there a free plan?
Yes. Every plan includes the agent, including free, and building from your own AI client spends no assistant credits.