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 an app.
AddItemCampaign Adds an item to a campaign.
AddItemCampaignActivity Adds an item to a campaign activity.
AddListMembersList Adds members to a list.
AddMemberList Adds a member to a list (marketing list).
AddMembersBatchList
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.
AddSolutionComponent Adds a solution component to an unmanaged solution.
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.
ApplyRecordCreationAndUpdateRule Applies record creation and update rules to activities in 365 created as a result of the integration with external applications.
ApplyRoutingRule Applies the active routing rule to an incident.
AutoMapEntity Generates a new set of attribute mappings based on the metadata.
BackgroundSendEmail Send email messages asynchronously.
BatchPrediction
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.
CalculateActualValueOpportunity Calculates the value of an opportunity that is in the "Won" state.
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.
CancelContract Cancels a contract.
CancelSalesOrder Cancels a sales order.
CancelTraining
CanManyToMany Checks whether an entity can participate in a many-to-many relationship.
CategorizeText
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.
CloneContract Copies an existing contract and its line items.
CloneMobileOfflineProfile For internal use only.
CloneProduct Copies an existing product family, product, or bundle under the same parent record.
CloseIncident Closes an incident (case).
CloseQuote Closes a quote.
CommitAnnotationBlocksUpload
CommitAttachmentBlocksUpload
CommitFileBlocksUpload
CompoundUpdateDuplicateDetectionRule Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.
ConvertOwnerTeamToAccessTeam Converts a team of type owner to a team of type access.
ConvertQuoteToSalesOrder Converts a quote to a sales order.
ConvertSalesOrderToInvoice Converts a sales order to an invoice.
CopyCampaign Copies a campaign.
CopyCampaignResponse Creates a copy of a campaign response
CopyDynamicListToStatic Creates a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.
CopyMembersList Copies the members from the source list to the target list without creating duplicates.
CopySystemForm Creates a new entity form that is based on an existing entity form.
CreateActivitiesList Creates a quick campaign to distribute an activity to members of a list (marketing list).
CreateAsyncJobToRevokeInheritedAccess Creates and executes an asynchronous cleanup job to revoke inherited access granted through cascading inheritance.
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.
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.
CreateWorkflowFromTemplate Creates a workflow (process) from a workflow template.
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.
DeleteAuditData Deletes all audit data records up until a specified end date.
DeleteFile
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
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.
DetectLanguage
DistributeCampaignActivity Creates a bulk operation that distributes a campaign activity.
DownloadBlock
ExecuteWorkflow Executes a workflow.
ExportMappingsImportMap Exports a data map as an XML formatted data.
ExportSolution Exports a solution.
ExportTranslation Exports all translations for a specific solution to a compressed file.
ExtractKeyPhrases
ExtractTextEntities
FulfillSalesOrder Fulfills a sales order.
FullTextSearchKnowledgeArticle Performs a full-text search on knowledge articles in Dynamics 365 using the specified search text.
GenerateInvoiceFromOpportunity Generates an invoice from an opportunity.
GenerateQuoteFromOpportunity Generates a quote from an opportunity.
GenerateSalesOrderFromOpportunity Generates a sales order (order) from an opportunity.
GenerateSocialProfile Returns an existing social profile record if one exists, otherwise generates a new one and returns it.
GetAutoNumberSeed
GetInvoiceProductsFromOpportunity Retrieves the products from an opportunity and copy them to the invoice.
GetJobStatus
GetNextAutoNumberValue
GetQuoteProductsFromOpportunity Retrieves the products from an opportunity and copy them to the quote.
GetSalesOrderProductsFromOpportunity Retrieves the products from an opportunity and copy them to the sales order.
GetTrackingTokenEmail Returns a tracking token that can then be passed as a parameter to the SendEmailRequest message.
GrantAccess Grants a security principal (organization, user, or team) access to the specified record.
ImmediateBook
ImportCardTypeSchema
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.
ImportSolutions
ImportTranslation Imports translations from a compressed file.
InitializeAnnotationBlocksDownload
InitializeAnnotationBlocksUpload
InitializeAttachmentBlocksDownload
InitializeAttachmentBlocksUpload
InitializeFileBlocksDownload
InitializeFileBlocksUpload
InitializeModernFlowFromAsyncWorkflow
InsertOptionValue Inserts a new option value for a global or local option set.
InsertStatusValue Inserts a new option into a StatusAttributeMetadata attribute.
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).
LockInvoicePricing Locks the total price of products and services that are specified in the invoice.
LockSalesOrderPricing Locks the total price of products and services that are specified in the sales order (order).
LoseOpportunity Sets the state of an opportunity to Lost.
Merge Merges the information from two entity records of the same type.
ModifyAccess Replaces the access rights on the target record for the specified security principal (user or team).
msdyn_AcceptProposedBooking For internal use only.
msdyn_AcceptTeamRecommendation For internal use only.
msdyn_AddInvoiceLineDetails For internal use only.
msdyn_ApprovalStatusApprove For internal use only.
msdyn_ApprovalStatusReject For internal use only.
msdyn_batchentityCUD For internal use only.
msdyn_BulkCreatePredecessorsForTask For internal use only.
msdyn_BulkDeletePredecessorsForTask For internal use only.
msdyn_CancelBookings For internal use only.
msdyn_ChangeRequestStatus For internal use only.
msdyn_cloneentity For internal use only.
msdyn_CloseAllOpportunityQuotes For internal use only.
msdyn_CloseQuoteAsLost For internal use only.
msdyn_CloseQuoteAsWon For internal use only.
msdyn_CompleteResourceRequest For internal use only.
msdyn_CopyProject For internal use only.
msdyn_CopyRelatedProjectEntitiesFromTemplate For internal use only.
msdyn_CopyWbsToProject For internal use only.
msdyn_CorrectInvoice For internal use only.
msdyn_CreateContractSpecificPriceList For internal use only.
msdyn_CreateExtensionRequirement For internal use only.
msdyn_createinvoicefrominvoiceschedule For internal use only.
msdyn_CreateQuoteLineDetailsFromEstimate For internal use only.
msdyn_CreateQuoteSpecificPriceList
msdyn_createrequestfromrequirement
msdyn_CreateSharepointDocumentLocation For internal use only.
msdyn_CreateTemplateFromProject
msdyn_DeleteEstimateLines For internal use only.
msdyn_DeleteEstimatesForProjectTask
msdyn_ExpenseEntriesPendingApproval For internal use only.
msdyn_ExpenseEntriesReject For internal use only.
msdyn_ExpenseEntriesSubmit For internal use only.
msdyn_ExpenseRejectAction
msdyn_ExpenseSubmitAction
msdyn_ExportActual
msdyn_FieldServiceSystemAction For internal use only.
msdyn_FpsAction For internal use only.
msdyn_GDPROptoutContact
msdyn_GDPROptoutLead
msdyn_GDPROptoutUser
msdyn_GenerateContractLineInvoiceSchedule For internal use only.
msdyn_GenerateContractLineScheduleOfValues For internal use only.
msdyn_GenerateQuoteLineInvoiceSchedule For internal use only.
msdyn_GenerateQuoteLineScheduleOfValues For internal use only.
msdyn_GetBookingDetailsByRequirementIds For internal use only.
msdyn_GetBookingDetailsByResource For internal use only.
msdyn_GetContractBillingRadialGaugeData For internal use only.
msdyn_GetContractLineChargeability For internal use only.
msdyn_GetContractLines For internal use only.
msdyn_GetDataForContractPerformance For internal use only.
msdyn_GetDataForRadialGauge For internal use only.
msdyn_GetDocumentManagementSettings For internal use only.
msdyn_GetDocumentStorePath For internal use only.
msdyn_GetEstimatesforProject
msdyn_GetMultipleResourceBookingDetails For internal use only.
msdyn_GetOfficeGroupForEntity For internal use only.
msdyn_GetPrice For internal use only.
msdyn_GetProcessNotes For internal use only.
msdyn_GetProductLine For internal use only.
msdyn_GetProductLines For internal use only.
msdyn_GetProjectCoparticipation For internal use only.
msdyn_GetProjectMapForContractLine For internal use only.
msdyn_GetProjectMapForQuoteLine For internal use only.
msdyn_GetProjects For internal use only.
msdyn_GetProjectsForQuote For internal use only.
msdyn_GetProposedResources For internal use only.
msdyn_GetQuoteLineChargeability For internal use only.
msdyn_GetRequirementChartData For internal use only.
msdyn_GetRequirementDemand For internal use only.
msdyn_GetResourceBookingDetails For internal use only.
msdyn_GetResourceBookingFormParameters For internal use only.
msdyn_GetResourcePopupDetails For internal use only.
msdyn_GetResources For internal use only.
msdyn_GetSummaryBookings For internal use only.
msdyn_GetTransactionUnitPrices For internal use only.
msdyn_GetUserTimeZoneName For internal use only.
msdyn_IndentWBSTask For internal use only.
msdyn_initializedefaultclonequery For internal use only.
msdyn_InvoiceRecalculate For internal use only.
msdyn_IsProjectTemplatesView For internal use only.
msdyn_IsSharePointEnabled
msdyn_JoinProjectTeam For internal use only.
msdyn_JsonGetNumber For internal use only.
msdyn_JsonGetString For internal use only.
msdyn_LoadFactTableEstimate For internal use only.
msdyn_MarkIntegrationJobAsFailedAsync For internal use only.
msdyn_MoveProject For internal use only.
msdyn_MoveUpWBSTask For internal use only.
msdyn_MSProject_LinkToProject For internal use only.
msdyn_MSProject_PublishToExistingProject For internal use only.
msdyn_MSProject_ReadFromExistingProject For internal use only.
msdyn_MSProject_ReadProjectTeamMembers For internal use only.
msdyn_OutdentWBSTask For internal use only.
msdyn_ParentIoTAlerts For internal use only.
msdyn_PostInvoice For internal use only.
msdyn_PostJournal For internal use only.
msdyn_ReadEstimateLines For internal use only.
msdyn_recallrequestforrequirement For internal use only.
msdyn_RecommendWork For internal use only.
msdyn_RegisterCustomEntity Registers any custom entity that may or may not already have connected IoT devices. This action invokes the IoT – Register Device action.
msdyn_ResourceAssignmentDetailUpdate For internal use only.
msdyn_RetrieveDistanceMatrix For internal use only.
msdyn_RetrieveResourceAvailability For internal use only.
msdyn_SetDefaultRole For internal use only.
msdyn_TimeEntriesApprove For internal use only.
msdyn_TimeEntriesCopyPaste For internal use only.
msdyn_TimeEntriesPendingApproval For internal use only.
msdyn_TimeEntriesReject For internal use only.
msdyn_TimeEntriesSubmit For internal use only.
msdyn_UpdateAllEstimatesForProject For internal use only.
msdyn_UpdateEstimateLines For internal use only.
msdyn_updateprojecttask For internal use only.
msdyn_updateremainingresourcerequirement For internal use only.
msdyn_UpdateRequirementDemand For internal use only.
msdyn_ValidateFixedPriceLineTotals For internal use only.
OrderOption Sets the order for an option set.
ParseImport Submits an asynchronous job that parses all import files that are associated with the specified import (data import).
PickFromQueue Assigns a queue item to a user and optionally remove the queue item from the queue.
Predict
PredictionSchema
ProcessInboundEmail Processes the email responses from a marketing campaign.
PropagateByExpression Creates a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.
ProvisionLanguage Provisions a new language.
ProvisionLanguageAsync
PublishAIConfiguration
PublishAllXml Publishes all changes to solution components.
PublishDuplicateRule Submits an asynchronous job to publish a duplicate rule.
PublishProductHierarchy Publishes a product family record and all its child records.
PublishTheme Publishes a theme and set it as the current theme.
PublishXml Publishes specified solution components.
QualifyLead Qualifies a lead and create account, contact, and opportunity records that are linked to the originating lead record.
QualifyMemberList Qualifies the specified list and either override the list members or remove them according to the specified option.
QueryExpressionToFetchXml Converts a QueryExpression query to its equivalent FetchXML query
QueueUpdateRibbonClientMetadata
QuickTest
ReactivateEntityKey Submit a new asynchronous system job to create the index for the key.
ReassignObjectsOwner Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsSystemUser Reassigns all records that are owned by a specified user to another security principal (user or team).
Recalculate Recalculate system-computed values for rollup fields in the goal hierarchy.
RecalculatePrice
ReleaseToQueue Assigns a queue item back to the queue owner so others can pick it.
RemoveAppComponents Removes app components from an app.
RemoveFromQueue Removes a queue item from a queue.
RemoveItemCampaign Removes an item from a campaign.
RemoveItemCampaignActivity Removes an item from a campaign activity.
RemoveListMembersList
RemoveMemberList Removes a member from a list (marketing list).
RemoveMembersTeam Removes members from a team.
RemoveParent Removes the parent for a system user (user) record.
RemovePrivilegeRole Removes a privilege from an existing role.
RemoveSolutionComponent Removes a component from an unmanaged solution.
RemoveUserFromRecordTeam Removes a user from the auto created access team for the specified record.
RenewContract Renews a contract and create the contract details for a new contract.
RenewEntitlement Renews an entitlement.
ReplacePrivilegesRole Replaces the privilege set of an existing role.
Reschedule Reschedules an appointment, recurring appointment, or service appointment (service activity).
ResetUserFilters Resets the offline data filters for the calling user to the default filters for the organization.
RevertProduct Reverts changes done to properties of a product family, product, or bundle record, and set it back to its last published (active) state.
ReviseQuote Sets the state of a quote to Draft.
RevokeAccess Replaces the access rights on the target record for the specified security principal (organization, user, or team).
RouteTo Routes a queue item to a queue, a user, or a team.
SchedulePrediction
ScheduleRetrain
ScheduleTraining
SendBulkMail Sends bulk email messages.
SendEmail Sends an e-mail message.
SendEmailFromTemplate Sends an e-mail message to a recipient using an e-mail template.
SendFax Sends a fax.
SendTemplate Sends a bulk email message that is created from a template.
SetAutoNumberSeed Sets a different starting value after creating the auto-numbering attribute.
SetBusinessSystemUser Moves a system user (user) to a different business unit.
SetDataEncryptionKey Sets or restore the data encryption key.
SetFeatureStatus For internal use only.
SetLocLabels Sets localized labels for a limited set of entity attributes.
SetParentSystemUser Sets a new parent system user (user) for the specified user.
SetProcess For internal use only.
SetReportRelated Links an instance of a report entity to related entities.
StageAndUpgrade
SyncBulkOperation
Train
TransformImport Submits an asynchronous job that transforms the parsed data.
TriggerServiceEndpointCheck Validates the configuration of a Microsoft Azure Service Bus solution’s service endpoint.
UninstallSampleData Uninstalls the sample data.
UnlockInvoicePricing Unlocks pricing for an invoice.
UnlockSalesOrderPricing Unlocks pricing for a sales order (order).
UnpublishAIConfiguration
UnpublishDuplicateRule Submits an asynchronous job to unpublish a duplicate rule.
UnschedulePrediction
UnscheduleTraining
UpdateFeatureConfig For internal use only.
UpdateOptionValue Updates an option value in a global or local option set.
UpdateProductProperties Updates values of the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.
UpdateRibbonClientMetadata
UpdateSolutionComponent Updates a component in an unmanaged solution.
UpdateStateValue Updates an option set value in for a StateAttributeMetadata attribute.
UploadBlock
Validate Verifies that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.
ValidateAIConfiguration
ValidateSavedQuery Validates a saved query.
ValidateUnpublished
WinOpportunity Sets the state of an opportunity to Won.
WinQuote Sets the state of a quote to Won.

See also