API Documentation

Upload Requests API

The Upload Requests API allows you to send upload requests and fetch details about the available upload request templates. These APIs require the Egnyte.uploadrequests scope.

List Templates

This endpoint is used to fetch a list of the available upload request templates. The information returned by this endpoint is needed when sending an upload request.

GET/pubapi/v1/upload-requests

Request Parameters

This endpoint does not have any request parameters


Request Examples

GET /pubapi/v1/upload-requests/templates HTTP/1.1
Host: apidemo.egnyte.com
Authorization: Bearer 68zc95e3xv954u6k3hbnma3q

Response

A successful request will return an HTTP 200 status code with a JSON response listing each template.

[
    {
        "templateId": "74403afb-1f9b-43f4-b219-a5acd29c41e0",
        "version": "1.0",
        "name": "Account Onboarding",
        "status": "ACTIVE",
        "assigneeInstructions": "Provide the following documents to help us create your account"
    }
]

Create Upload Request

This endpoint is used to create a new Upload Request.

POST/pubapi/v1/upload-requests

Request Parameters in the Request Body

Parameter Description Required Possible Values
name Name of the upload request Yes String
example: Account Onboarding
dueDate Date and time the request is due, formatted as an ISO 8601 date/time string Yes String in ISO 8601 format
example: 2025-03-21T16:18:09.450Z
folderId The ID of the folder the request will be created in Yes String
example: 6e4465e9-2713-4b16-a787-3560b50f2236
templateId The ID of the template, available from the List Templates endpoint Yes String
example: 0af99f3d-a2d6-4a4e-af81-b2aab2d58787
assignees An array of assignees for the upload request. Each item in the array is an object that has either a userId key (for internal users) or an externalEmail key (for external users). Yes Array of objects
example: 
[
    {"userId": 47},
    {"externalEmail": "bob@example.com"}
]
assigneeInstructions Instructions that will be shown to the user on the Upload Request's General Request Details screen.
Note: you can access the default instructions for the template from the List Templates endpoint		 Yes String
example: Provide the following documents to help us create your account

Request Examples

    POST /pubapi/v1/upload-requests HTTP/1.1
    Host: apidemo.egnyte.com
    Authorization: Bearer 68zc95e3xv954u6k3hbnma3q
    Content-Type: application/json
    {
        "name": "Account Onboarding",
        "dueDate": "2025-03-21T16:18:09.450Z",
        "folderId": "6e4465e9-2713-4b16-a787-3560b50f2236",
        "templateId": "0af99f3d-a2d6-4a4e-af81-b2aab2d58787",
        "assignees": [
            {"userId": 47},
            {"externalEmail": "bob@example.com"}
        ],
        "assigneeInstructions": "Provide the following documents to help us create your account"
      }

Sample Response

A successful request will return an HTTP 201 status code with the ID of the upload request.

  {
      "id": "e250227d-044c-45b5-9dbb-c1120a856b84"
  }

version 2 as of 4 days ago by Greg Neustaetter