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
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).
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
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.
CanManyToMany Checks whether an entity can participate in a many-to-many relationship.
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.
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).
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.
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.
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.
DistributeCampaignActivity Creates a bulk operation that distributes a campaign activity.
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.
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.
GetInvoiceProductsFromOpportunity Retrieves the products from an opportunity and copy them to the invoice.
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 (user or team) access to the specified record.
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.
ImportTranslation Imports translations from a compressed file.
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
msdyn_AcceptTeamRecommendation
msdyn_AddInvoiceLineDetails
msdyn_applyworktemplate
msdyn_applyworktemplateforresources
msdyn_ApprovalStatusApprove
msdyn_ApprovalStatusReject
msdyn_AssignGenericResource
msdyn_AutoGenerateProjectTeam
msdyn_batchentityCUD
msdyn_BookingResource
msdyn_BookingResourceRequirement
msdyn_BulkCreatePredecessorsForTask
msdyn_BulkDeletePredecessorsForTask
msdyn_CancelBookings
msdyn_ChangeRequestStatus
msdyn_cloneentity
msdyn_CloseAllOpportunityQuotes
msdyn_CloseQuoteAsLost
msdyn_CloseQuoteAsWon
msdyn_CompleteResourceRequest
msdyn_CopyProject
msdyn_CopyRelatedProjectEntitiesFromTemplate
msdyn_CopyWbsToProject
msdyn_CorrectInvoice
msdyn_CreateContractLineDetailsFromEstimate
msdyn_CreateContractSpecificPriceList
msdyn_CreateEstimateLines
msdyn_CreateEstimatesForProjectTask
msdyn_CreateExtensionRequirement
msdyn_createinvoicefrominvoiceschedule
msdyn_CreateQuoteFromOpportunity
msdyn_CreateQuoteLineDetailsFromEstimate
msdyn_CreateQuoteSpecificPriceList
msdyn_createrequestfromrequirement
msdyn_CreateSharepointDocumentLocation
msdyn_CreateTaskBasedEstimatesForProject
msdyn_CreateTemplateFromProject
msdyn_DeleteEstimateLines
msdyn_DeleteEstimatesForProjectTask
msdyn_ExpenseApproveAction
msdyn_ExpenseEntriesApprove
msdyn_ExpenseEntriesPendingApproval
msdyn_ExpenseEntriesRecall
msdyn_ExpenseEntriesReject
msdyn_ExpenseEntriesSubmit
msdyn_ExpenseRejectAction
msdyn_ExpenseSubmitAction
msdyn_ExportActual
msdyn_FetchProjectCalendarWorkHours
msdyn_FieldServiceSystemAction
msdyn_FpsAction
msdyn_FulfillResourceDemand
msdyn_GenerateContractLineInvoiceSchedule
msdyn_GenerateContractLineScheduleOfValues
msdyn_GenerateQuoteLineInvoiceSchedule
msdyn_GenerateQuoteLineScheduleOfValues
msdyn_GeocodeAddress
msdyn_GetAvailabilitySummaryFromDemand
msdyn_GetBookingDetailsByRequirementIds
msdyn_GetBookingDetailsByResource
msdyn_GetCollectionData
msdyn_GetContractBillingRadialGaugeData
msdyn_GetContractDetailedTransactions
msdyn_GetContractEffortRadialGaugeData
msdyn_GetContractLineChargeability
msdyn_GetContractLines
msdyn_GetDataForContractPerformance
msdyn_GetDataForRadialGauge
msdyn_GetDocumentManagementSettings
msdyn_GetDocumentStorePath
msdyn_GetEstimatesforProject
msdyn_GetGenericResourceDetails
msdyn_GetMultipleResourceBookingDetails
msdyn_GetMyChangedSkills
msdyn_GetOfficeGroupForEntity
msdyn_GetPrice
msdyn_GetProcessNotes
msdyn_GetProductLine
msdyn_GetProductLines
msdyn_GetProjectCoparticipation
msdyn_GetProjectCurrencies
msdyn_GetProjectDetails
msdyn_GetProjectMapForContractLine
msdyn_GetProjectMapForQuoteLine
msdyn_GetProjects
msdyn_GetProjectsForContract
msdyn_GetProjectsForQuote
msdyn_GetProjectTaskCategories
msdyn_GetProposedResources
msdyn_GetQuoteLineChargeability
msdyn_GetRequirementChartData
msdyn_GetRequirementDemand
msdyn_GetRequirementDemandDisplay
msdyn_GetResourceAvailability
msdyn_GetResourceAvailabilitySummary
msdyn_GetResourceBookingByProject
msdyn_GetResourceBookingDetails
msdyn_GetResourceBookingFormParameters
msdyn_GetResourceDemandTimeLine
msdyn_GetResourcePopupDetails
msdyn_GetResources
msdyn_GetSummaryBookings
msdyn_GetTimelineData
msdyn_GetTransactionUnitPrices
msdyn_GetUserTimeZoneName
msdyn_IndentWBSTask
msdyn_initializedefaultclonequery
msdyn_InvoicePaid
msdyn_InvoiceRecalculate
msdyn_IoTSendTestAlert [Reserved for future use.]
msdyn_IsProjectTemplatesView
msdyn_JoinProjectTeam
msdyn_JsonGetBoolean Reads a Boolean property in the specified JSON object.
msdyn_JsonGetNumber Reads a numeric property in the specified JSON object.
msdyn_JsonGetString Reads a text property in the specified JSON object
msdyn_LoadFactTableEstimate
msdyn_LogFindWorkEvent
msdyn_MarkIntegrationJobAsFailedAsync
msdyn_MoveDownWBSTask
msdyn_MoveProject
msdyn_MoveUpWBSTask
msdyn_MSProject_ExportToProject
msdyn_MSProject_GetFindResourcesURL
msdyn_MSProject_LinkToProject
msdyn_MSProject_PublishToExistingProject
msdyn_MSProject_ReadFromExistingProject
msdyn_MSProject_ReadProjectTeamMembers
msdyn_MSProject_UnlinkFromProject
msdyn_NewInvoiceContract
msdyn_OutdentWBSTask
msdyn_ParentIoTAlerts Calls the IoT - Debounce IoT Alerts action and passes 60 for the TimeSpan parameter.
msdyn_PostInvoice
msdyn_PostJournal
msdyn_ProjectTeamMemberSignUpProcess
msdyn_ProjectTeamMemberSignupprocessaccept
msdyn_ProjectTeamUpdateMembershipStatus
msdyn_ReadEstimateLines
msdyn_recallrequestforrequirement
msdyn_RecommendWork
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_RegisterIoTDevice Publishes the registration requests for an IoT device.
msdyn_RejectProposedBooking
msdyn_ResAssignResourcesForTask
msdyn_ResGetResourceDetail
msdyn_ResolveTimezone
msdyn_ResourceAssignmentDetailUpdate
msdyn_ResourceReservationCancel
msdyn_ResourceSubstitution
msdyn_ResourceUtilization
msdyn_ResourceUtilizationChart
msdyn_RetrieveDistanceMatrix
msdyn_RetrieveResourceAvailability
msdyn_SaveProjectLineTasks
msdyn_SetDefaultRole
msdyn_SubmitCategoriesAndPriceLists
msdyn_SubmitRolesAndPriceLists
msdyn_TimeEntriesApprove
msdyn_TimeEntriesCopyPaste
msdyn_TimeEntriesPaste
msdyn_TimeEntriesPendingApproval
msdyn_TimeEntriesRecall
msdyn_TimeEntriesReject
msdyn_TimeEntriesSubmit
msdyn_UpdateAllEstimatesForProject
msdyn_UpdateChangedSkills
msdyn_UpdateEffortContour
msdyn_UpdateEstimateLineDetails
msdyn_UpdateEstimateLines
msdyn_updateprojecttask
msdyn_updateremainingresourcerequirement
msdyn_UpdateRequirementDemand
msdyn_ValidateFixedPriceLineTotals
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.
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.
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
ReactivateEntityKey
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.
ReleaseToQueue Assigns a queue item back to the queue owner so others can pick it.
RemoveAppComponents
RemoveFromQueue Removes a queue item from a queue.
RemoveItemCampaign Removes an item from a campaign.
RemoveItemCampaignActivity Removes an item from a campaign activity.
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 (user or team).
RouteTo Routes a queue item to a queue, a user, or a team.
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 the initial value for the auto-number attribute.
SetBusinessSystemUser Moves a system user (user) to a different business unit.
SetDataEncryptionKey Sets or restore the data encryption key.
SetFeatureStatus internal
SetLocLabels Sets localized labels for a limited set of entity attributes.
SetParentSystemUser Sets a new parent system user (user) for the specified user.
SetProcess Sets the process that associates with a given target entity. The user can set to another business process or specify null to clear out the current process.
SetReportRelated Links an instance of a report entity to related entities.
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).
UnpublishDuplicateRule Submits an asynchronous job to unpublish a duplicate rule.
UpdateFeatureConfig internal
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.
UpdateSolutionComponent Updates a component in an unmanaged solution.
UpdateStateValue Updates an option set value in for a StateAttributeMetadata attribute.
Validate Verifies that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.
ValidateSavedQuery Validates a saved query.
WinOpportunity Sets the state of an opportunity to Won.
WinQuote Sets the state of a quote to Won.

See Also