Skip to content

DocuSign: Creates a workspace file

DocuSign esignature.esignatureWorkspaceFilePostWorkspaceFiles: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_workspacefile_postworkspacefiles

Provider route: POST /restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureWorkspaceFilePostWorkspaceFiles"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureWorkspaceFilePostWorkspaceFiles(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_workspace_file_post_workspace_files(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.folderIdstringRequired within parent
path.workspaceIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a workspace file — response body

Referenced models: Creates a workspace file — response body

Creates a workspace file — response body
FieldTypePresenceDescription and constraints
$objectRootThis object represents an item in a workspace, which can be either a file or folder.
callerAuthorizationModelOptionalExpand Creates a workspace file — response body — user Authorization
contentTypestringOptionalIf the item is a file, this property specifies the content type of the file.
createdstringOptionalThe UTC DateTime when the workspace item was created.
createdByIdstringOptionalThe ID of the user who created the workspace item.
createdByInformationModelOptionalExpand Get Workspace — response body — caller Information
Details about the user who created the workspace item.
extensionstringOptionalThe file extension of a file item.
fileSizestringOptionalThe size of the file in bytes.
fileUristringOptionalThe URI for retrieving the file.
idstringOptionalA unique ID for the Salesforce object.
isPublicstringOptionalWhen **true,** the item is public.
lastModifiedstringOptionalThe UTC date and time that the comment was last updated.

**Note:** This can only be done by the creator.
lastModifiedByIdstringOptionalThe ID of the user who last modified the item.
lastModifiedByInformationModelOptionalExpand Get Workspace — response body — caller Information
Details about the user who last modified the workspace item.
namestringOptionalThe name of the file or folder.
pageCountstringOptionalThe number of pages in a file.
parentFolderIdstringOptionalThe ID of the parent folder, or the special value `root` for the root folder.
parentFolderUristringOptionalThe URI of the parent folder.
sha256stringOptionalA 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.
thumbHeightstringOptionalThe height of the thumbnail image.
thumbWidthstringOptionalThe width of the thumbnail image.
thumbnailModelOptionalExpand Creates a workspace file — response body — thumbnail
typestringOptionalThe type of the workspace item. Valid values are file, folder.
uristringOptionalA URI containing the user ID.
userAuthorizationModelOptionalExpand Creates a workspace file — response body — user Authorization

Referenced models: Creates a workspace file — response body — thumbnail, Get Workspace — response body — caller Information, Creates a workspace file — response body — user Authorization

Creates a workspace file — response body — thumbnail
FieldTypePresenceDescription and constraints
$objectRootDescription of a page of a document.
dpistringOptionalThe number of dots per inch used for the page image.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
If an error occurs, this property describes the error.
heightstringOptionalThe height of the page in pixels.
Must be an integer.
imageBytesstringOptionalThe number of image bytes.
mimeTypestringOptionalThe MIME type.
pageIdstringOptionalThe ID of the page.
sequencestringOptionalThe sequence of the page in the document, or page number.
widthstringOptionalThe width of the page in pixels.
Must be an integer.

Referenced models: Locks a template — response body — error Details

Get Workspace — response body — caller Information
FieldTypePresenceDescription and constraints
$objectRootThis object represents the workspace user. This property is only returned in response to user specific GET call.
accountIdstringOptionalThe account ID associated with the workspace user.
accountNamestringOptionalThe name of the account that the workspace user belongs to.
activeSincestringOptionalThe UTC DateTime when the user joined the workspace.
createdstringOptionalThe UTC DateTime when the workspace user was created.
createdByIdstringOptionalThe ID of the user who created this workspace user.
emailstringOptionalThe workspace user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
invitationEmailBlurbstringOptionalThe text of the workspace invitation email message sent to the user.
invitationEmailSubjectstringOptionalThe subject line of the workspace invitation email message sent to the user.
lastModifiedstringOptionalThe UTC DateTime that the workspace user was last modified.
lastModifiedByIdstringOptionalThe ID of the user who last modified the workspace user.
statusstringOptionalFilters the results by user status.
You can specify a comma-separated
list of the following statuses:

* ActivationRequired
* ActivationSent
* Active
* Closed
* Disabled
typestringOptionalType of the user. Valid values: type_owner, type_participant.
userIdstringOptionalThe ID of the workspace user.
userNamestringOptionalThe name of workspace user.
workspaceIdstringOptionalThe ID of the workspace.
workspaceUserBaseUrlstringOptionalThe URL for accessing the workspace user.
workspaceUserIdstringOptionalThe ID of the workspace user.
workspaceUserUristringOptionalThe URI for accessing the workspace user.

Referenced models: Locks a template — response body — error Details

Creates a workspace file — response body — user Authorization
FieldTypePresenceDescription and constraints
$objectRootProvides properties that describe user authorization to a workspace.
canDeletestringOptionalWhen **true,** the workspace user can delete items from the workspace.
canMovestringOptionalWhen **true,** the workspace user can move the items in the workspace.
canTransactstringOptionalWhen **true,** the workspace user can create transactions from the workspace.
canViewstringOptionalWhen **true,** the workspace user can view the items in the workspace.
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdByIdstringOptionalThe ID of the user who created the workspace user authorization.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
modifiedstringOptionalThe UTC DateTime when the workspace user authorization was last modified.
modifiedByIdstringOptionalThe ID of the user who last modified the workspace user authorization.
workspaceUserIdstringOptionalThe ID of the workspace user.
workspaceUserInformationModelOptionalExpand Get Workspace — response body — caller Information
An object that provides details about the workspace user.

Referenced models: Locks a template — response body — error Details, Get Workspace — response body — caller Information

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_workspacefile_postworkspacefiles. Catalog operation: esignature:WorkspaceFile_PostWorkspaceFiles. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.