Skip to navigation

Updates a specific upload request

View as Markdown

This operation updates a specific upload request within a workspace. Only draft upload requests can be edited. The editable fields are name, description, due date, and status. Status changes are restricted - only transitions from draft to in_progress are allowed. Attempting to update a non-draft upload request will result in an INVALID_STATUS error. Attempting an invalid status change will result in an INVALID_STATUS_CHANGE error.

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
uploadRequestIdstringRequiredformat: "uuid"
The ID of the upload request to update

Request

The upload request object with updated values
namestring or nullRequired

The name of the upload request (editable)

descriptionstring or nullRequired

The description of the upload request (editable)

statusenumRequired
Enum representing the status of a workspace upload request
Allowed values:
due_datedatetime or nullOptional

The due date for the upload request (editable)

assignmentslist of objects or nullOptional
List of user assignments for the upload request

Response

Upload request successfully updated
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