Web API Action Reference
Actions represent operations which may have observable side effects, such as creating or updating records. An Action may require parameters and may return a value. Actions may be bound to entity types.
In this section
| Name | Description |
|---|---|
| AddAppComponents | Adds app components to a business app. |
| AddCertificateCredential | |
| AddComponentsToSolutionAsync | |
| AddComponentToSolutionAsync | |
| AddMembersTeam | Adds members to a team. |
| AddPrincipalToQueue | Adds the specified principal to the list of queue members. |
| AddPrivilegesRole | Adds a set of existing privileges to an existing role. |
| AddRecurrence | Adds recurrence information to an existing appointment. |
| AddRequiredDesktopFlowComponentsToSolutions | Adds the required components for the Desktop Flow to all solutions the Desktop Flow is in. |
| AddRequiredUIElementCollectionComponentsToSolutions | Add the required components for the UI Element Collection to all solutions the UI Element Collection is in. |
| AddSolutionComponent | Adds a solution component to an unmanaged solution. |
| AddToFeedbackLoop | API to add a feedback loop item to a model. |
| AddToQueue | Moves an entity record from a source queue to a destination queue. |
| AddUserToRecordTeam | Adds a user to the auto created access team for the specified record. |
| AddWorkQueueItemProcessingHistoryEntry | Add a processing history entry. |
| AIClassify | Classifies/Categorizes the text into one of the provided categories using AI builder GPT action. |
| AIExtract | Extracts user-defined data points from provided text using AI builder GPT action. |
| AIModelPublish | Create or update a custom model. |
| AIReply | Drafts a response to the given text using AI builder GPT action |
| AISentiment | Detect the sentiment of the given text using AI builder GPT action (positive, negative, or neutral) |
| AISummarize | Summarizes the given text using AI builder GPT action. |
| AISummarizeRecord | Summarizes the given entity record using AI builder GPT action. |
| AITranslate | Translate text to English using AI. |
| AlmHandler | Synchronizes models in the AI Builder backend. |
| Analyze | Initiates process mining for the process to generate analytics on the associated data. |
| AnalyzeSentiment | Analyzes sentiments. |
| AppendRelatedParty | Appends the specified party as a Related activity party to the specified Activity. |
| ApplyRecordCreationAndUpdateRule | Applies record creation and update rules to activities in Dataverse created as a result of the integration with external applications. |
| AutoMapEntity | Generates a new set of attribute mappings based on the metadata. |
| BackgroundSendEmail | Send email messages asynchronously. |
| BatchGetFlowMachineStatus | Returns the current connection status for the stated machines. |
| BatchPrediction | Runs batch prediction on an AI Model. |
| BeginMachineImageProvisioning | Triggers export of a generalized image from the Power Automate Desktop Flow hosted machine to hosted group. Use this API to trigger the provisioning of a VM image from an existing Hosted Machine. |
| Book | Schedules or 'books' an appointment, recurring appointment, or service appointment (service activity). |
| BulkDelete | Submits a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities. |
| BulkDetectDuplicates | Submits an asynchronous system job that detects and logs multiple duplicate records. |
| BulkRemoveActiveCustomizationsAsync | |
| BulkRetain | Marks records for retention based on the criteria. |
| CalculatePrice | Calculates price in an opportunity, quote, order, and invoice. |
| CanBeReferenced | Checks whether the specified entity can be the primary entity (one) in a one-to-many relationship. |
| CanBeReferencing | Checkes whether an entity can be the referencing entity in a one-to-many relationship. |
| CancelAllCloudFlowRuns | Cancel all active runs for a Cloud Flow. |
| CancelDesktopFlowRun | Cancel an ongoing desktop flow run. |
| CancelTraining | Cancels the training of an AI model. |
| CanManyToMany | Checks whether an entity can participate in a many-to-many relationship. |
| CardCreateClone | Clones a card. |
| CardGetFullJson | Retrieves the JSON for a card. |
| cascadeAsync_SuccessAPI | Register a plug-in step on this message to be notified when an asynchronous cascade operation succeeds. |
| CategorizeText | Categorizes text. |
| ClearWorkQueue | Remove all items in the work queue. |
| CloneAsPatch | Creates a solution patch from a managed or unmanaged solution. |
| CloneAsSolution | Creates a new copy of an unmanged solution that contains the original solution plus all of its patches. |
| CloneMobileOfflineProfile | For internal use only. |
| CommitAnnotationBlocksUpload | Commits the uploaded data blocks to the annotation store. |
| CommitAttachmentBlocksUpload | Commits the uploaded data blocks to the attachment store. |
| CommitFileBlocksUpload | Commits the uploaded data blocks to the file store. |
| CommitToGit | Push your changes to git. |
| CompoundUpdateDuplicateDetectionRule | Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions. |
| ComputeSlaWorkQueueItem | Compute SLA status on work queue items in the work queue. |
| ConnectToGit | Connect an environment or solution to Git. |
| ConvertOwnerTeamToAccessTeam | Converts a team of type owner to a team of type access. |
| CopySystemForm | Creates a new entity form that is based on an existing entity form. |
| CreateAndSendNewEmail | Creates and sends an email using the Send action. |
| CreateAsyncJobToRevokeInheritedAccess | Creates an async job to correct inherited access. |
| CreateCustomerRelationships | Creates a new customer lookup attribute, and optionally, to add it to a specified unmanaged solution. |
| CreateException | Creates an exception for the recurring appointment instance. |
| CreateFlowCredentialApplication | Triggers the creation of a Flow Credential Application. |
| CreateFlowMachineNetwork | Triggers the creation of Flow Machine Network to be used for hosted bots. |
| CreateHostedFlowMachineGroup | Creates a hosted machine group. |
| CreateInstance | Creates future unexpanded instances for the recurring appointment master. |
| CreateKnowledgeArticleTranslation | Creates translation of a knowledge article instance. |
| CreateKnowledgeArticleVersion | Creates a major or minor version of a knowledge article instance. |
| CreateMultiple | Creates multiple records of the same type in a single request. |
| CreateNPSUserRating | Creates an NPS user rating. |
| CreatePolymorphicLookupAttribute | Create a multi-table lookup column. |
| CreateRoleWithPrivilegeCheckerRun | Creates a role using privilegecheckerlog records associated with the privilegecheckerrun record that this action is bound to. |
| CreateRpaBox | Creates an RPA box. |
| CreateVirtualConnectorTable | |
| CreateWorkflowFromTemplate | Creates a workflow (process) from a workflow template. |
| DeactivateEntityKey | Deactivates an alternate key for a table. |
| DeleteAndPromote | Replaces managed solution (A) plus all of its patches with managed solution (B) that is the clone of (A) and all of its patches. |
| DeleteAndPromoteAsync | Asynchronously replaces managed solution (A) plus all of its patches with managed solution (B) that is the clone of (A) and all of its patches. |
| DeleteAuditData | Deletes all audit data records up until a specified end date. |
| DeleteFile | Deletes a stored binary file, attachment, or annotation. |
| DeleteFlowMachineGroup | Deletes the bound flow machine group. |
| DeleteMultiple | Creates multiple records of the same type in a single request. |
| DeleteOpenInstances | Deletes instances of a recurring appointment master that have an 'Open' state. |
| DeleteOptionValue | Deletes an option value in a global or local option set. |
| DeleteRecordChangeHistory | Deletes all audit change history records for a particular record. |
| DeliverImmediatePromoteEmail | Delivers an email from an email client. |
| DeliverIncomingEmail | Creates an email activity record from an incoming email message. |
| DeliverPromoteEmail | Creates an email activity record from the specified email message |
| DeprovisionLanguage | Deprovisions a language. |
| Dequeue | Retrieve the next work queue item to be processed. |
| DetectLanguage | Detects the language. |
| DisconnectFromGit | Disconnect an environment or solution(s) from Git. |
| DiscoverFabricAISkills | Discover Fabric AISkill. |
| DiscoverFabricWorkspaces | Discover Fabric Workspaces. |
| DownloadBlock | Downloads a data block. |
| DownloadSolutionExportData | Download the exported solution data. |
| ExecuteWorkflow | Executes a workflow. |
| ExportMappingsImportMap | Exports a data map as an XML formatted data. |
| ExportRetainedData | Exports retained data to Excel |
| ExportSolution | Exports a solution. |
| ExportSolutionAsync | Exports a solution using an asynchronous job. |
| ExportSolutionFromGit | Export a solution from Git. |
| ExportSolutionFromGitAsync | Export a solution from Git asynchronously. |
| ExportTranslation | Exports all translations for a specific solution to a compressed file. |
| ExtractKeyPhrases | Extracts key phrases from text. |
| ExtractTextEntities | Extracts entities from inputted text. |
| FormPredict | Predict the next field in a record given context. |
| FullTextSearchKnowledgeArticle | Performs a full-text search on knowledge articles in Dynamics 365 using the specified search text. |
| GenerateSharedLink | Generates a shareable link that grants access to the specified record for office collaboration. |
| GenerateSocialProfile | Returns an existing social profile record if one exists, otherwise generates a new one and returns it. |
| GetAuditStorageDetails | Retrieves Audit log storage details which provides an overview of which Dataverse tables consume how much log space. |
| GetAutoNumberSeed | Returns the value set as the seed value for a specified table and column. |
| GetCertificateCredential | |
| GetEntityLinkChatConfig | For internal use only. |
| GetJobStatus | Get the status of a job. The message status returned contains the correlation id and the organization id. |
| GetLinkedChats | For internal use only. |
| GetNextAutoNumberValue | Returns the value that will be assigned to the next record for a specified table and column based on the last autonumber used. |
| GetOrCreateSharedWorkspace | Get existing sharedworkspace with matching name or create it if it does not exist. |
| GetPublicKey | Returns the public key of a FlowMachineGroup of FlowGroupType Default. |
| GetRunMap | List Power Automate runs associated with the Business Process and match them with the process map. |
| GetTrackingTokenEmail | Returns a tracking token that can then be passed as a parameter to the SendEmailRequest message. |
| GrantAccess | Grants a security principal (user, team, or organization) access to the specified record. |
| GrantDelegatedAccess | Grant delegated access to the table based on the provided delegated authorization. |
| ImmediateBook | Books an appointment obeying the scheduling engine selected and resource availability. If the resources involved are available at the specified time, this operation creates new appointment record and returns a successful validation result. Otherwise, it returns a failed validation result. |
| ImportCardTypeSchema | Imports and create a new cardtype required by the installed solution. |
| ImportFieldTranslation | Imports translations from a compressed file. |
| ImportMappingsImportMap | Imports the XML representation of a data map and create an import map (data map) based on this data. |
| ImportRecordsImport | Submits an asynchronous job that uploads the transformed data into Microsoft Dynamics 365. |
| ImportSolution | Imports a solution. |
| ImportSolutionAsync | Imports a solution using an asynchronous job. |
| ImportTranslation | Imports translations from a compressed file. |
| ImportTranslationAsync | Imports translations from a compressed file asynchronously. |
| Ingest | Initializes ingestion for a recording to prep it to be ready for labelling and process mining. |
| InitializeAnnotationBlocksDownload | Initialize the download of one or more annotation data blocks. |
| InitializeAnnotationBlocksUpload | Initializes annotation storage for receiving (uploading) one or more annotation data blocks. |
| InitializeAttachmentBlocksDownload | Initializes the download of one or more attachment data blocks. |
| InitializeAttachmentBlocksUpload | Initializes attachment storage for receiving (uploading) one or more attachment data blocks. |
| InitializeFileBlocksDownload | Initializes the download of one or more binary data blocks. |
| InitializeFileBlocksUpload | Initializes file storage for receiving (uploading) one or more binary data blocks. |
| InitializeModernFlowFromAsyncWorkflow | For internal use only. |
| InsertOptionValue | Inserts a new option value for a global or local option set. |
| InsertStatusValue | Inserts a new option into a StatusAttributeMetadata attribute. |
| install | Creates an endpoint for an individual user to invoke a flow with the necessary connections that are specific to the invoker. |
| InstallSampleData | Installs the sample data. |
| InstantiateFilters | Instantiates a set of filters for Dynamics 365 for Outlook for the specified user. |
| InstantiateTemplate | Creates an email message from a template (email template). |
| IsPaiEnabled | Checks whether AI Builder is enabled on a given environment. |
| IsPmEnabled | Determines if the process mining feature is enabled. |
| JoinLinkedChat | For internal use only. |
| LeaveGroup | Leaves the curent flowmachinegroup and created a default flowmachinegroup for the bound flowmachine. |
| ListChildDesktopFlows | List the ids and etag of all the child flow dependencies of a given desktop flow script. |