X

Overview

Events

Actions

Home > Application Reference > Dropbox

Jump to a Section

Overview

Authorizing an Account

The first time you add a Dropbox card to a Flow, you need to set up a configuration for that account. Setting up a configuration will allow you to connect the Designer to your Dropbox account, save the data, and reuse that configuration next time you build a Flow using this Dropbox account. That way, you don’t have to sign in every time you want to build a Flow using Dropbox. After you’ve set up one configuration, you can choose to use that configuration again, or set up a new one.

Note: The Dropbox connector is designed to interact with User, not Business, accounts. If you attempt to use a Business account with any of the Dropbox cards, authorization will not function properly.

You can set up and save multiple configurations and share them with your teammates. Here’s how to set up a new configuration in Dropbox:

  1. Add the Dropbox card you would like to use to your Flow. If you already have configurations set up, you will have to select Add Account to create a new configuration. If you don’t have any configurations set up, you will automatically be taken to the next step.
  2. Name your configuration. Choose something unique, since you may need to be able to tell multiple configurations apart in the future.
  3. Click Create.
  4. In the popup window, you may be asked to sign into Dropbox if you aren’t already logged in.
  5. Next, select which account to link Designer access to your Dropbox data. You can reuse this configuration any time you use Dropbox in a Flow.

    Events

    • File Created or Updated

      Monitors a Dropbox account for when a new file is created or updated.

      Output Fields

      • File
        • Name (text): name of the file that was created/updated
        • Unique ID (text): unique id associated with the file
        • Path (text): path to the file (e.g., /pictures/2016/4/…)
        • Revision Number (text): description of input field
        • Client Time Modified (text): when the file was last modified by the user, based on client time
        • Server Time Modified (text): when the file was last modified by the user, based on server time
        • Size (text): the size of the file
      • Sharing Info 
        • Read Only? (text): a true/false value specifying whether or not the file is read only
        • Parent Folder ID (text): the unique id associated with the parent folder containing the updated/created file
        • Modified By (text): the user who last modified the file
      • context
        • Execution ID (text): an internal Execution ID

    • File or Folder Removed

      Triggers a Flow when a file or a folder is removed

      Fields

      • Folder
        • Name (text): The name of the file or folder.
        • Unique ID (text): The  ID of the file or folder which was removed.
        • Path (text): The file or folder path.
      • Context
        • Execution ID (text): The ID for the event.

    • Folder Created or Updated

      File Created or Uploaded

      Monitors a Dropbox account for when a new folder is created or updated.

      Note that monitoring occurs on the entire account and any new or update to a folder will trigger this Flow. If only certain folders or files need to be monitored, Flow should include functions (e.g. ‘Continue if’, ‘If/Else’) to specify actions that should or should not be performed.

      Output Fields

      • File
        • Name (text): name of the file that was created/updated
        • Unique ID (text): unique id associated with the file
        • Path (text): path to the file (e.g., /pictures/2016/4/…)
      • Sharing Info 
        • Read Only? (text): a true/false value specifying whether or not the file is read only
        • Parent Folder ID (text): the unique id associated with the parent folder containing the updated/created file
      • context
        • Execution ID (text): an internal Execution ID

    Actions

    • Copy File or Folder

      Copy a File or a Folder (single or hierarchy) inside of Dropbox and specify the location where that copied item is saved to.

      Input Fields

      Copy From

      • Path (text):
        • This path specifies the specific file or folder that currently exists in Dropbox that you want to copy. A very specific format exists for both and looks like the following:
          • Folder - /[Insert Folder Name] - this can be extensible to go multiple layers deep if you need to clone a very specific subfolder - /[Insert Top Folder Name]/[Insert Second Folder Name]….
          • File - /[Insert Folder Name]/[Insert File Name]
          • NOTE: Dropbox prevents a user from being able to copy a folder that is currently being shared.
        • Path can be easily accessed by using the Search Files or Folders card. Path is an output of that card.

      Copy To

      • New Path (text): Path of desired location. (“/” is the default location.) - See “Copy From” above for more information.
      • New Name (text): Name of the file.

      Output Fields

      • Revision Number (text): Revision number.
      • New Path (text):Path of copied file or folder (defaults to “/”).

    • Create Folder

      Creates a folder at the designated path

      Input Fields

      • Parent Folder

        • Path (text): path of the folder to create the folder within

      • Folder

        • Name (text): name of the folder being created

      Output Fields

      • Output
        • Path (text): path of the new folder
        • Folder ID (text): ID of the new folder

    • Create Share Link

      Creates a share link for a file or folder.

      Options

      • Visibility (text): Choose “Password”, “Public”, or “Team Only”.

      Input Fields

      • File or Folder
        • Path (text): the location/ identifier for the file or folder.

      Output Fields

      • Link (URL): URL share link is returned.

    • Delete File or Folder

      Deletes a specified file or folder in Dropbox.

      Input Fields

      • File/Folder
        • Path (text): Path of the file or folder to be deleted (Use ‘/’ before the name of a folder).
          • ie: /[Insert Folder Name]/[Insert File Name]
          • Path can be easily accessed by using the Search Files or Folders card. Path is an output of that card.

      More help for paths here.

      Output Fields

      There are no output fields for this card.

    • Get File

      Input an identifier for a file and get information back about that specific file.

      Input Fields

      NOTE: Not all input fields are required to return a result. Using a File Path or File ID along will return a result. Using a revision number enables a user to locate information about version specific iterations of the file.

      • Get By

        • File Path (text):This path specifies the specific file that currently exists in Dropbox that you get information from. A very specific format exists for both and looks like the following:

          • File – /[Insert Folder Name]/[Insert File Name]
          • Path can also be easily accessed by using the Search Files or Folders card. Path is an output of that card.

        • File ID (type): Unique ID of the file.

        • Revision Number (type): Revision number of the file.

      Output Fields

      • Results
        • Name (text): Name of uploaded file.
        • Unique ID (text): Unique ID of the uploaded file.
        • Path (text): Path of uploaded file.
        • Type (text): file or folder.
        • Revision Number (text): Revision number.
        • Client Time Modified (text): The time the file was most recently modified, based on client time.
        • Server Time Modified (text): The time the file was most recently modified, based on server time.
        • Size (text): Size of the file.
      • Sharing Info
        • Read Only (text): Read only metadata.
        • Parent Shared Folder ID (text): ID of the folder the file is located in.
        • Modified By (text): ID of the user who modified the document.

    • Get File by Share Link

      Gets information on a file given the URL and the password.

      Input Fields

      • Read by
        • URL (text): The share link URL.
        • Password (text): The password associated with the file.

      Output Fields

      • File
        • Name (text): the name of the file.
        • Unique ID (text): the file ID.
        • Path (text): the path of the file.
        • Revision number (text): number of revisions.
        • Client Time Modified(text)
        • Server Time Modified(text)
        • Size(text): size of the file.
        • File Content(file): the content in the file.
      • Sharing Info
        • Read Only (text)
        • Parent Folder ID (text)
        • Modified By(text): Who made changes
      • Content Owner
        • Account ID(text)
        • Same Team(text)
        • Team Member ID(text)
        • Name(text): The name of the owner
        • Last Name(text)
        • Email(text)

    • Move File or Folder

      Change the location/path of a file or a folder in Dropbox.

      Input Fields

      • Move From

        • Path (text): Path of the file or folder to be deleted (Use ‘/’ before the name of a folder).
          • ie: /[Insert Folder Name]/[Insert File Name]
          • Path can be easily accessed by using the Search Files or Folders card. Path is an output of that card.

      • Move To

        • New Path (text): New location.
        • New Name (text): Rename the file or folder.

      Output Fields

      • New Path (text)

    • Read File Metadata

      Gets the Metadata for a file.

      Input Fields

      • Read by
        • File Path (text): Path of the file or folder to be deleted (Use ‘/’ before the name of a folder).
          • ie: /[Insert Folder Name]/[Insert File Name]
        • File ID (text): the file ID.
        • Revision Number (text): the revision number.

      Output Fields

      • File

        • Name (type): the file name.
        • Unique ID (type): the file ID
        • Path (text): the path of the file.
        • Revision number (text): number of revisions.
        • Client Time Modified(text)
        • Server Time Modified(text)
        • Size(text): size of the file.
        • File Content(file): the content in the file.

      • Sharing Info

        • Read Only (text)
        • Parent Folder ID (text)
        • Modified By(text): Who made changes

    • Read Folder Metadata

      Reads and returns a folder’s metadata based on either the folder’s ID or path in Dropbox.

      Input Fields

      • Read by (IMPORTANT: Only use ONE of these input fields. Using both will lead to an error, even if the data is accurate.)
        • Folder Path (text): the path of folder you want to read the metadata from (e.g., /pictures/2016/4/…)
        • Folder ID (text): the unique id associated with the folder you want to read metadata from

      Output Fields

      • Folder
        • Name (text): name of the folder that was read
        • Folder ID (text): unique id associated with the folder
        • Path (text): path to the folder (e.g., /pictures/2016/4/…)
      • Sharing Info 
        • Read Only? (text): a true/false value specifying whether or not the folder is read only
        • Parent Shared Folder ID (text): the unique id associated with the parent shared folder containing the updated/created folder
        • Shared Folder ID (text): the unique id associated with the shared folder
      • Owner
        • Account ID (text): the unique id associated with the owner of the folder in Dropbox
        • Same Team (text): whether or not the owner of this Dropbox folder is in the same team as the account you are using
        • Team Member ID (text): the unique id associated with the owner of the folder in relation to the team they’re in
        • Name (text): the name associated with the owner in Dropbox
        • Last Name (text): the last name associated with the owner in Dropbox
        • Email (text): the email associated with the owner of the folder in Dropbox

    • Read Shared Folder Permissions

      Gets permissions information for a shared folder.

      Input Fields

      • Read by
        • Shared Folder ID (text): the folder ID. Can be found by using ‘Search Files or Folders’.

      Output Fields

      • Permissions
        • Current User Access Type (text)
        • Is Team Folder (text)__
        • ACL Update Policy (text)
        • Shared Link Policy (text)
        • Member Policy (text)
        • Resolved Member Policy (text)

    • Remove Folder Member

      Removes a member from a shared folder.

      Options

      • Leave a copy for member (Y/N):

      Input Fields

      • Folder
        • Shared Folder ID (text): The ID of the folder containing the member to be removed. Can be found by using ‘Search Files or Folders’.
      • Member
        • Email (text): the member’s email.
        • Account or Team Member ID (text): the ID of the member.

      Output Fields

      • There are no outputs for this card.

    • Search Files or Folders

      Search files and folders for a specified file.

      Input Fields

      • Search
        • Path (text): Path of desired location to search from (Use ‘/’ before the name of a folder).
        • Query (text): Name of file or folder to search.

      Output Fields

      • Results

        • Type (text): file or folder.
        • Name (text): Name of uploaded file.
        • Unique ID (text): Unique ID of the uploaded file.
        • Path (text): Path of uploaded file.
        • Revision Number (text): Revision number.
        • Client Time Modified (text): The time the file was most recently modified, based on client time.
        • Server Time Modified (text): The time the file was most recently modified, based on server time.
        • Size (text): Size of the file.

      • Sharing Info

        • Read Only (text): Read only metadata.
        • Parent Shared Folder ID (text): ID of the folder the file is located in.

    • Share Folder

      .Shares a folder and updates permissions.

      Options

      • Leave a copy for member (Y/N):

      Input Fields

      • Folder

        • Folder Path (text): Path of the file or folder to be deleted (Use ‘/’ before the name of a folder).
          • ie: /[Insert Folder Name]/[Insert File Name]
          • Path can be easily accessed by using the Search Files or Folders card. Path is an output of that card.

      • Permissions

        • Member Policy (text): Who can be a member of this shared folder. Only applicable if the current user is on a team. This field is optional.
        • ACL Update Policy (text): Who can add and remove members of this shared folder. This field is optional.
        • Shared Link Policy (text): The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members. This field is optional.

      Output Fields

      • New Path (text)

    • Unshare Folder

      Unshares a shared folder.

      Options

      • Leave a copy for members (T/F)

      Input Fields.

      • Folder
        • Shared Folder ID (text): The ID of the folder that will be unshared.

      Output Fields

      • There are no output fields for this card.

    • Update Folder Permissions

      Updates the folder permissions of a shared folder.

      Input Fields

      • Update by
        • Shared Folder ID (text): the folder ID.
      • Update
        • Member Policy (text): Who can be a member of this shared folder. Only applicable if the current user is on a team.
        • ACL Update Policy (text): Who can add and remove members of this shared folder.
        • Shared Link Policy (text): The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.

      Output Fields

      • There are no output fields for this card.

    • Upload File

      Upload a file to Dropbox.

      • Options
        • Upload Mode (dropdown list):
          • Add (text): Upload a new file to Dropbox - will not upload if a file already exists.
          • Overwrite (text): Sets overwrite parameter to true; overwrites a file in Dropbox with the same filename or path. Add a file if none exist.
          • Update (text): Update an existing file - throws an error if there isn’t a file to update.
        • Auto Rename (text): Will rename a file if a naming conflict occurs.
        • Mute (text): Mute notifications for this file.

      Input Fields

      • File
        • Name (text): Name of the file.
        • Path (text): Path of desired location. (“/” is the default location.)
        • File Content (object): The file to be uploaded to Dropbox.

      Output Fields

      • File
        • Name (text): Name of uploaded file.
        • Unique ID (text): Unique ID of the uploaded file.
        • Path (text): Path of uploaded file (defaults to “/”).
        • Revision Number (text): Revision number.
        • Client Time Modified (text): The time the file was most recently modified, based on client time.
        • Server Time Modified (text): The time the file was most recvently modified, based on server time.
        • Size (text): Size of the file.