Create workspace file

POST

/v2.1/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files

POST

/restapi/v2.1/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/workspaces/WORKSPACE_ID/folders/FOLDER_ID/files \
     -H "Authorization: Bearer <apiKey>"

{
  "callerAuthorization": {
    "canDelete": "sample string 1",
    "canMove": "sample string 2",
    "canTransact": "sample string 3",
    "canView": "sample string 4",
    "created": "sample string 5",
    "createdById": "sample string 6",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "modified": "sample string 7",
    "modifiedById": "sample string 8",
    "workspaceUserId": "sample string 9",
    "workspaceUserInformation": {
      "accountId": "sample string 1",
      "accountName": "sample string 2",
      "activeSince": "sample string 3",
      "created": "sample string 4",
      "createdById": "sample string 5",
      "email": "sample string 6",
      "invitationEmailBlurb": "sample string 7",
      "invitationEmailSubject": "sample string 8",
      "lastModified": "sample string 9",
      "lastModifiedById": "sample string 10",
      "status": "sample string 11",
      "type": "sample string 12",
      "userId": "sample string 13",
      "userName": "sample string 14",
      "workspaceId": "sample string 15",
      "workspaceUserBaseUrl": "sample string 16",
      "workspaceUserId": "sample string 17",
      "workspaceUserUri": "sample string 18"
    }
  },
  "contentType": "sample string 1",
  "created": "sample string 2",
  "createdById": "sample string 3",
  "extension": "sample string 4",
  "fileSize": "sample string 5",
  "fileUri": "sample string 6",
  "id": "sample string 7",
  "isPublic": "sample string 8",
  "lastModified": "sample string 9",
  "lastModifiedById": "sample string 10",
  "name": "sample string 11",
  "pageCount": "sample string 12",
  "parentFolderId": "sample string 13",
  "parentFolderUri": "sample string 14",
  "sha256": "sample string 15",
  "thumbHeight": "sample string 16",
  "thumbnail": {
    "dpi": "sample string 1",
    "height": "sample string 2",
    "imageBytes": "sample string 3",
    "mimeType": "sample string 4",
    "pageId": "sample string 5",
    "sequence": "sample string 6",
    "width": "sample string 7"
  },
  "thumbWidth": "sample string 17",
  "type": "sample string 18",
  "uri": "sample string 19"
}

This method adds a file to a workspace.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

folderIdstringRequired

The ID of the folder.

workspaceIdstringRequired

The ID of the workspace.

Response

Successful response.

callerAuthorizationobjectOptional

Provides properties that describe user authorization to a workspace.

contentTypestringOptional

If the item is a file, this property specifies the content type of the file.

createdstringOptional

The UTC DateTime when the workspace item was created.

createdByIdstringOptional

The ID of the user who created the workspace item.

createdByInformationobjectOptional

This object represents the workspace user. This property is only returned in response to user specific GET call.

extensionstringOptional

The file extension of a file item.

fileSizestringOptional

The size of the file in bytes.

fileUristringOptional

The URI for retrieving the file.

idstringOptional

A unique ID for the Salesforce object.

isPublicstringOptional

When true, the item is public.

lastModifiedstringOptional

The UTC date and time that the comment was last updated.

Note: This can only be done by the creator.

lastModifiedByIdstringOptional

The ID of the user who last modified the item.

lastModifiedByInformationobjectOptional

This object represents the workspace user. This property is only returned in response to user specific GET call.

namestringOptional

The name of the file or folder.

pageCountstringOptional

The number of pages in a file.

parentFolderIdstringOptional

The ID of the parent folder, or the special value root for the root folder.

parentFolderUristringOptional

The URI of the parent folder.

sha256stringOptional

A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused.

thumbHeightstringOptional

The height of the thumbnail image.

thumbnailobjectOptional

Description of a page of a document.

thumbWidthstringOptional

The width of the thumbnail image.

typestringOptional

The type of the workspace item. Valid values are file, folder.

uristringOptional

A URI containing the user ID.

userAuthorizationobjectOptional

Provides properties that describe user authorization to a workspace.

Errors

400

Bad Request Error