Skip to navigation
How-to guides

How to create a workspace upload request

View as Markdown

This topic demonstrates how to create a workspace upload request. Each workspace upload request represents a task in a workspace that is assigned to specific participants, such as asking a wealth management client to upload proof of income like a pay stub or tax document.

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PowerShell.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{API_ACCOUNT_ID}A GUID value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field on the Apps and Keys page.
{WORKSPACES_BASE_PATH}A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at
https://<domain>
Where <domain> is https://api-d.docusign.com/v1 for the developer environment and https://api.docusign.com/v1 for production.
{PARTICIPANT_EMAIL}The email address for the workspace participant to whom the upload request will be assigned.
{DUE_DATE}The due date of the upload request.
{WORKSPACE_ID}The ID of the workspace within which the upload request will be created. Run the How to create a workspace code example before doing this walkthrough to ensure that this value is available.
{WORKSPACE_CREATOR_ID}The GUID ID of the user who created the workspace. Run the How to create a workspace code example before doing this walkthrough to ensure that this value is available.

Step 1. Obtain your OAuth token

To make the API call shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario.

Wondering which grant type suits your integration? See Authenticate for guidance on your options to get an OAuth token.

Workspaces OAuth access tokens are the same ones used for our eSignature REST API, although you must request the signature scope and one or more Workspaces scopes to call the Workspaces API.

See Workspaces authentication for details and the full list of Workspaces scopes.

Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant

Step 2. Construct your API headers

After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.

declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
    '--header' "Accept: application/json" \
    '--header' "Content-Type: application/json")

Step 3. Construct the request body

Next, create the request body. An upload request requires a name, description, due date, and assignments. The following example shows a request body with all required fields. Make sure to substitute your due date for {DUE_DATE}, your email for {SIGNER_EMAIL}, and your workspace creator ID for {WORKSPACE_CREATOR_ID}.

printf \
'{
    "name": "Upload Request example '"${DUE_DATE}"'",
    "description": "This is an example upload request created via the workspaces API",
    "due_date": "'"${DUE_DATE}"'",
    "assignments": [
        {
            "upload_request_responsibility_type_id": "assignee",
            "first_name": "Test",
            "last_name": "User",
            "email": "'"${SIGNER_EMAIL}"'"
        },
        {
            "assignee_user_id": "'"${workspace_creator_id}"'",
            "upload_request_responsibility_type_id": "watcher"
        }
    ],
    "status": "draft"
}' >> $request_data

Step 4. Call the Workspaces API

Now that you have constructed your API headers and request body, make a POST request to the Workspaces: createWorkspaceUploadRequest endpoint and include the request body to create the workspace. Here’s how you make the call, but make sure to substitute your API account ID for {account_id} and your workspace ID for {workspace_id}.

View the source code for this how-to on GitHub: Bash, C#, Java, Node.js, and PowerShell.

Status=$(curl -s -w "%{http_code}\n" -i \
     --request POST ${base_path}/accounts/${account_id}/workspaces/${workspace_id}/upload-requests \
    "${Headers[@]}" \
    --data-binary @${request_data} \
    --output ${response})

Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown.

Expected response
{"upload_request_id":"4c290dad-3e1b-4a9f-b8d1-de90eb0a2104","workspace_id":"50db67eb-0405-4043-b2c6-8a291e595f8b","name":"Upload Request example 2025-11-13T11:49:34Z","description":"This is an example upload request created via the workspaces API","upload_request_owner":{"user_id":"c0c1f365-b1a1-42a0-b0d4-090950b97fac"},"status":"draft","documents":[],"assignments":[{"assignee_user_id":"c0c1f365-b1a1-42a0-b0d4-090950b97fac","upload_request_responsibility_type_id":"watcher"},{"assignee_user_id":"8946d162-a27f-4753-912e-16411adaab8e","upload_request_responsibility_type_id":"assignee"}],"created_date":"2025-11-06T19:49:37.74Z","updated_date":"2025-11-06T19:49:37.787Z","due_date":"2025-11-13T11:49:34Z","sent_date":null,"completed_date":null,"can_view":true,"can_edit":true,"can_delete":true}

Next steps