What is a Dropbox?

  1. It is a place where users can submit content.
  2. It notifies its members when new content arrives.
  3. It can ask the users that submit new content to fill out a form. It does this using something called a metadata schema.

Examples

GET /dropboxes?workspace_id=x9b

List the current User's dropboxes (including those the user has access to through other groups) in the specified workspace. When using an admin-scoped token, all dropboxes in the workspace will be returned, regardless of whether the user has access.

GET /dropbox_memberships?embed%5B%5D=dropbox&member_type=group&member_id=5C&workspace_id=x9b

List a Group's direct dropbox memberships (not including those the group has access to through other groups) in the specified workspace:

GET /dropbox_memberships?embed%5B%5D=member&dropbox_id=x9b

List a dropbox's direct members (those explicitly assigned to the dropbox):

Properties:

  • content_retention_duration - in seconds, overrides workspace settings (read-write for admins)
  • delete_package_content_after_download_duration - in seconds, overrides workspace settings(read-write for admins)
  • description
  • effective_content_retention_duration - in seconds, takes into account whether workspace settings are inherited (read-only)
  • effective_delete_package_content_after_download_duration - in seconds, takes into account whether workspace settings are inherited (read-only)
  • id - (read-only)
  • inherit_workspace_expiration_settings - boolean (read-only, read-write for admins)
  • instructions - instructions presented to users who submit packages to the dropbox
  • metadata_schema
  • name - (required)
  • recipients_group_id - (read-only) id of group containing all members with "can_receive_packages"
  • senders_group_id - (read-only) id of group containing all members with "can_submit_packages"
  • workspace_id - (required)

Query Parameters (for GET):

  • created_at
  • name
  • q - Search description and name
  • updated_at
  • workspace_id

Metadata Schemas

A metadata schema is used to present a form to a user when the user is submitting content to a Dropbox. It is an array with "Field" objects, and each Field object defines one field that the user can fill out when submitting content to a Dropbox. Note that the order of the fields in the metadata schema array should be the order they are shown to the user.

A metadata schema field has these properties:

Properties:

  • choices - (array)
  • input_type - multiple-checkbox, single-dropdown, single-text, textbox.
  • name
  • required - (boolean)

Examples

{"name": "City", "input_type": "single-text"}
{"name": "US Citizen?", "input_type": "single-dropdown", "choices": ["Yes", "No"]}
{"name": "Ice Cream Flavors", "input_type": "multiple-checkbox", "choices": ["Vanilla", "Chocolate"]}

GET and POST

GET, PUT, and DELETE

Properties:

  • can_invite_submitters
  • can_receive_packages
  • can_submit_packages
  • creator_id - (read-only)
  • dropbox_id - (required, POST-only)
  • id - (read-only)
  • manager - (read-only except to organization admins and workspace managers)
  • member_id - (required, POST-only)
  • member_type - (required, POST-only)
  • submit_expired (read-only) - true/false, whether or not member&39;s submit ability has expired
  • submit_expires_at
  • workspace_id - (read-only)

Query Parameters (for GET):

  • can_invite_submitters
  • can_receive_packages
  • can_submit_packages
  • created_at
  • creator_id
  • deactivated
  • dropbox_id
  • embed%5B%5D=dropbox
  • embed%5B%5D=member
  • inherited - (boolean) Only show the memberships that are inherited through group membership, or (when false) only show the direct memberships.
  • last_login_at - DEPRECATED: use member.last_login_at
  • manager - true/false
  • member.email
  • member.first_name
  • member.last_login_at
  • member.last_name
  • member.name
  • member.system_group
  • member_id
  • member_type
  • q - Search member.email, member.first_name, member.last_name, and member.name
    • q=jacob will search members for "jacob"
    • q=last_login_at:>2015-01-01 (URI escaped: q=last_login_at%3A%3E2015-01-01) will search for all member users who have logged in since January 1st, 2015.
  • updated_at
  • workspace_id

GET and POST

GET, PUT, and DELETE

Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×