Workspace Items
Creates a workspace file
This method adds a file to a workspace.
Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
folderId*string
The ID of the folder.
workspaceId*string
The ID of the workspace.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/workspaces/string/folders/string/files"{ "callerAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } }, "contentType": "string", "created": "string", "createdById": "string", "createdByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "extension": "string", "fileSize": "string", "fileUri": "string", "id": "string", "isPublic": "string", "lastModified": "string", "lastModifiedById": "string", "lastModifiedByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "name": "string", "pageCount": "string", "parentFolderId": "string", "parentFolderUri": "string", "sha256": "string", "thumbHeight": "string", "thumbnail": { "dpi": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "height": "string", "imageBytes": "string", "mimeType": "string", "pageId": "string", "sequence": "string", "width": "string" }, "thumbWidth": "string", "type": "string", "uri": "string", "userAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } }}Deletes files or sub-folders from a workspace DELETE
This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.
Gets a workspace file GET
This method returns a binary version of a file in a workspace.