Dropboxes and Workgroups (API v.4)

This endpoint allows you to query or modify dropboxes and workgroups (either "dropbox" or "workgroup" is included in the call to the endpoint).

Create (POST), edit (PUT), and delete (DELETE) requests are only available for requests that include "admin" in the call to the endpoint.

For GET requests, the non-admin versions of the endpoints return information for only those workgroups or dropboxes to which the requesting user belongs. GET requests to the endpoints that contain "admin" return information for all dropboxes and workgroups and additional fields that are not included in non-admin requests.

Note: In each endpoint method described below, workgroup|dropbox indicates that you can enter either workgroup or dropbox in the request.

Response Attributes

For admins, these attributes can also be submitted as parameters in a POST, PUT, or DELETE request. A label of "(read-only)" in the table below indicates that the attribute is automatically generated by the system.


Attributes for Both Dropboxes and Workgroups

Attribute Name Type Description
admin_can_add_group boolean Admin can add a workgroup (true/false)
admin_can_add_existing_users boolean Admin can add existing users (true/false)
admin_can_create_users boolean Admin can create users (true/false)
destination_share_id string ID for the destination share (default: null)
upload_directly_to_custom_inbox boolean Can upload package directly to custom inbox (true/false)
id unsigned integer ID for dropbox or workgroup (read-only)
created_at ISO date format Date and time when dropbox or workgroup created (read-only)
updated_at ISO date format Date and time when the dropbox or workgroup updated (read-only)
workgroup_received_notification_cc boolean Workgroup received notification of event (default:null)

Dropbox-only Attributes

Attribute Name Type Description
dbox_admin_can_invite boolean Dropbox admin can invite a user (true/false)
dbox_can_have_public_url boolean Dropbox can have a public URL (true/false)
dbox_mdata_profile_id unsigned integer ID for the dropbox metadata profile
dbox_require_ear boolean Dropbox requires encryption-at-rest (true/false)
dbox_save_metadata_to_file boolean Whether or not dropbox saves metadata to a file
dbox_standard_users_can_invite boolean Non-admin users can invite other users to be a member of a dropbox (true/false)
custom_package_expiration_policy boolean Custom package expiration policy exists
days_until_packages_expire unsigned integer Days until packages expire
delete_after_download_policy unsigned integer Criteria for file deletion. Available values: 0 (no deletion), 1 (delete after all recipients download all files), 2 (delete after the first full download / after any recipient downloads a file)
packages_expire insigned integer Number of days after upload that packages expire

Workgroup-only Attributes

Attribute Name Type Description
e_wg_name string Workgroup name
e_wg_desc string Workgroup description
wg_member_access string Type of workgroup member access. Available types: Mutual
wg_type string Type of workgroup. Available types: Moderated, Members-only

Common Error Codes

  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 404 No Content - Package not found; returns an error object
  • 500 HTTP Internal Server Error - Request is valid but the server encountered an error; returns an error object

Get current dropboxes or workgroups

Regular users:
GET /api/dropboxes|workgroups

Admin users:
GET /api/admin/dropboxes|workgroups

This method returns an array of current dropboxes or workgroups. Non-admin users get information for only those dropboxes or workgroups of which they are a member.

Request Body: None

Success Response Code

  • 200 OK - Returns an array of dropboxes and workgroups

Get information about a dropbox or workgroup

Regular users:
GET /api/dropboxes|workgroups/{id}

Admin users:
GET /api/admin/dropboxes|workgroups/{id}

This method returns information about a particular dropbox or workgroup. The {id} submitted in the request corresponds to one of the IDs returned by the Get current dropboxes or workgroups method, above.

Request Body: None

Success Response Code

  • 200 OK - Returns information about the dropbox or workgroup

Create a dropbox or workgroup 

POST /api/admin/dropboxes|workgroups

This method creates a new dropbox or workgroup.

Request Body: Include the dropbox or workgroup parameters you need (e_wg_name and e_wg_desc are required).

Success Response Code

  • 200 Created - Returned with information about the newly created dropbox or workgroup

Update a dropbox or workgroup 

PUT /api/admin/dropboxes|workgroups/{id}

This method updates the specified dropbox or workgroup. The {id} submitted in the request corresponds to one of the IDs returned by the Get current dropboxes or workgroups method, above.

Request Body: Includes the dropbox or workgroup attributes you need to update

Example: 

 
  "workgroup":
     {
         "upload_directly_to_custom_inbox": false,
         "wg_type": "Moderated",
         "e_wg_name": "New name (edited)",
         "e_wg_desc": "test workgroup new name (edited)",
         "destination_share_id": 3,
         "wg_member_access": "Mutual"
     }
}

Success Response Code

  • 200 OK - Returns the updated dropbox or workgroup information

Delete a workgroup or dropbox 

DELETE /api/admin/dropboxes|workgroups/{id}

This method deletes the specified dropbox or workgroup. The {id} submitted in the request corresponds to one of the IDs returned by the Get current dropboxes or workgroups method, above.

Request Body: None

Success Response Code

  • 204 No Content - Returned without a response body

Request and Response Example: Create a Workgroup


Request: 

POST /api/admin/workgroups

Request Body:

{"workgroup" : 
    {
      "e_wg_name" : "new-workgroup", 
      "e_wg_desc": "my new workgroup" 
    } 
}

Response: 

201 CREATED
	{
		"admin_can_add_existing_users":false,
		"admin_can_create_users":true,
		"created_at":"2016/06/20 15:25:07 -0700",
    		"custom_package_expiration_policy":false,
    		"days_until_packages_expire":60,
    		"delete_after_download_policy":0,
    		"destination_share_id":null,
    		"e_wg_desc":"workgroup description",
    		"e_wg_name":"workgroup name",
    		"forwarding_enabled":false,
    		"id":5,
   		"packages_expire":false,
    		"updated_at":"2016/06/20 15:25:07 -0700",
    		"upload_directly_to_custom_inbox":false,
    		"wg_member_access":"Mutual",
    		"wg_type":"Members-only",
    		"workgroup_received_notification_cc":null
	}
Video player

Video

×