Skip to navigation

Creates a new upload request within a workspace

View as Markdown

This operation creates a new upload request within a workspace. The upload request includes name, description, due date, and user assignments. New upload requests only support draft and in_progress statuses. Exactly one assignee is required, and each assignee must include first name, last name, and email. When status is in_progress, the request is sent immediately after creation.

Required authentication scopes: dtr.rooms.write

Authentication

AuthorizationBearer
JWT Bearer token from Docusign authorization server

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the account
workspaceIdstringRequiredformat: "uuid"
The ID of the workspace

Request

The upload request details including name, description, assignments, and status
namestring or nullRequired
The name of the upload request
descriptionstring or nullRequired
The description of the upload request
assignmentslist of objects or nullRequired
List of user assignments for the upload request
due_datedatetime or nullOptional
The due date for the upload request
statusenumOptional
Enum representing the status of a workspace upload request
Allowed values:

Response

Upload request successfully created
upload_request_idstringformat: "uuid"
The ID of the upload request
workspace_idstringformat: "uuid"
The ID of the workspace
namestring or null
The name of the upload request
upload_request_ownerobject
statusenum
Enum representing the status of a workspace upload request
Allowed values:
documentslist of objects or null
List of documents associated with the upload request
assignmentslist of objects or null
List of user assignments for the upload request
created_datedatetime or null
The date the upload request was created
updated_datedatetime or null
The date the upload request was last updated
descriptionstring or nullOptional
The description of the upload request
due_datedatetime or nullOptional
The due date for the upload request
sent_datedatetime or nullOptional
The date the upload request was sent
completed_datedatetime or nullOptional
The date the upload request was completed

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error