For AI agents: visit https://developer-docs.datamotion.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
DataMotionDataMotion
API Reference
Log InDataMotion
API Reference
Log In
API Reference

Pre-Requisite

  • Before Getting Started

Direct Messaging API

  • Using the Direct Messaging API
  • Account
    • Get A Session Keypost
    • Get Your Account Detailsget
    • Change Your Passwordpost
    • Logoutpost
  • Folder
    • List All Foldersget
    • Create A New Folderpost
    • Delete A Folderdel
  • Message
    • Get Message Summariespost
    • Get Unread Messagesget
    • Search the Inboxpost
    • Get A Messageget
    • Get Message Metadataget
    • Get A MIME Messageget
    • Send A Messagepost
    • Send A MIME Messagepost
    • Move A Messagepost
    • Delete A Messagedel
    • Retract A Messagepost
  • Group Mailboxes
    • Show Delegatesget
    • Add Delegatesput
    • Delete Delegatesdel
    • Show Groupbox Membershipget
    • Get Group Inbox MIDpost
    • Get Group Message Summariespost
    • Get Group Inboxget
    • Get Unread Group Inboxget

Direct HPD Search API

  • Using the HPD Search API
  • Get A Session Keypost
  • Search The HPDget
  • NPI Searchget

Direct Provisioning API

  • Using the Direct Provisioning API
  • Certificate
    • Request an Organizational Certificatepost
    • Request an Address Certificatepost
    • Request a Patient Certificatepost
    • Revoke a Certificatepost
    • Check Certificate Statuspost
  • User
    • Provision A Userpost
    • Delete A Userpost
    • Check A User's Provisioning Statuspost

Secure Messaging API V3

  • Using the Secure Messaging API (V3)
  • Account
    • Retrieves details about the current user's account.get
    • Retrieves the current user's settings.get
    • Retrieves a specified Cobrand. If the specified Cobrand is not found, default values are returned.get
    • Changes a user's password.put
    • Triggers the forgot password workflow for a user (first step in the forgot password process).post
    • Resets a user's password. Last step of the forgot password workflow process.put
    • Submits password reset security question answers. 2nd step of the forgot password workflow process (if security questions are required to be answered for the user).post
    • Retrieves a list of security questions a user can choose from when selecting their password reset security questions and setting their answers.get
    • Sets the password security question answers for the current user.post
  • Contacts
    • Get a list of Address book contactsget
    • Create a Address book contactpost
    • Get a contact information by the Idget
  • File
    • Download a file for a given fileId.get
    • DELETE A FILEdel
    • Upload a file to a new message (as an attachment).post
    • Upload a file to an existing message (as an attachment).post
  • Message
    • Get a MIME message for a given Message ID (MID)get
    • GET MESSAGE METADATAget
    • Generates a reply to a given message as the user associated with the access token.post
    • Forwards a given message as the user associated with the access token.post
    • Retracts a message from any recipients that have received the message.patch
    • Move a particular message into a specific folder.patch
    • Create new draft message.post
    • Update a draft message.put
    • Send a draft.patch
    • Get a message.get
    • Retrieves the message summary information of all messages using the specified criteria.get
    • Send a new message.post
    • Retrieves the unique messageIds of messages using the specified criteria.get
    • Delete a message from a folderdel
    • Sends a formatted MIME message.post
  • Folders
    • This method is used to retrieve a list of the user’s folders and corresponding statistics.get
    • Create a folderpost
    • Update a folderput
    • Delete a folderdel
  • Token
    • Retrieves an access token.post
    • Revoke a tokendel
    • Challenge endpoint to request MFA (via Email). Call this endpoint to MFA via email when you receive MFA required error in the token endpoint.post

Secure Admin API

  • Using The Secure Admin API
  • Authentication
    • Get A Session Keypost
    • Get An Encryption Keypost
    • Create A New Encryption Key (PSK)post
  • Account
    • List User Accountspost
    • Create a User Accountpost
    • View a User Accountpost
    • Update a User Accountpost
    • Delete a User Accountpost
    • Get UserTypesget

Secure Provisioning API

  • Using The Secure Provisioning API
  • Provision a Companypost
  • Get an Encryption Keypost
  • Create New Encryption Keypost

Secure Message Delivery

  • Using the Secure Message Delivery API
  • Send a Secure Messagepost
  • Track a Secure Messageget
  • Retract a Secure Messagedel

Clinical Message Delivery

  • Using the Clinical Message Delivery API
  • Send a Secure Messagepost
  • Track a Secure Messageget
Powered by 

User

All user requests are described in this section. These include the following:

  • Provision A User
  • Delete A User
  • Check A User's Provisioning Status

Updated about 1 year ago


Check Certificate Status
Provision A User
Did this page help you?

Updated about 1 year ago


Check Certificate Status
Provision A User
Did this page help you?