Update workspace file or folder metadata

PUT

/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files/:fileId

PUT

/restapi/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files/:fileId

curl -X PUT https://demo.docusign.net/restapi/v2/accounts/accountId/workspaces/workspaceId/folders/folderId/files/fileId \
     -H "Authorization: <apiKey>"

{
  "callerAuthorization": {
    "canDelete": "string",
    "canMove": "string",
    "canTransact": "string",
    "canView": "string",
    "created": "string",
    "createdById": "string",
    "errorDetails": {
      "errorCode": "string",
      "message": "string"
    },
    "modified": "string",
    "modifiedById": "string",
    "workspaceUserId": "string",
    "workspaceUserInformation": {
      "accountId": "string",
      "accountName": "string",
      "activeSince": "string",
      "created": "string",
      "createdById": "string",
      "email": "string",
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "lastModified": "string",
      "lastModifiedById": "string",
      "status": "string",
      "type": "string",
      "userId": "string",
      "userName": "string",
      "workspaceId": "string",
      "workspaceUserBaseUrl": "string",
      "workspaceUserId": "string"
    }
  },
  "contentType": "string",
  "created": "string",
  "createdById": "string",
  "createdByInformation": {
    "accountId": "string",
    "accountName": "string",
    "activeSince": "string",
    "created": "string",
    "createdById": "string",
    "email": "string",
    "errorDetails": {
      "errorCode": "string",
      "message": "string"
    },
    "lastModified": "string",
    "lastModifiedById": "string",
    "status": "string",
    "type": "string",
    "userId": "string",
    "userName": "string",
    "workspaceId": "string",
    "workspaceUserBaseUrl": "string",
    "workspaceUserId": "string"
  },
  "extension": "string",
  "fileSize": "string",
  "fileUri": "string",
  "id": "string",
  "isPublic": "string",
  "lastModified": "string",
  "lastModifiedById": "string",
  "lastModifiedByInformation": {
    "accountId": "string",
    "accountName": "string",
    "activeSince": "string",
    "created": "string",
    "createdById": "string",
    "email": "string",
    "errorDetails": {
      "errorCode": "string",
      "message": "string"
    },
    "lastModified": "string",
    "lastModifiedById": "string",
    "status": "string",
    "type": "string",
    "userId": "string",
    "userName": "string",
    "workspaceId": "string",
    "workspaceUserBaseUrl": "string",
    "workspaceUserId": "string"
  },
  "name": "string",
  "pageCount": "string",
  "parentFolderId": "string",
  "parentFolderUri": "string",
  "type": "string",
  "uri": "string"
}

Updates workspace item metadata for one or more specific files/folders.

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

fileIdstringRequired

Specifies the room file ID GUID.

folderIdstringRequired

The ID of the folder being accessed.

workspaceIdstringRequired

Specifies the workspace ID GUID.

Response

Successful response.

callerAuthorizationobjectOptional

Provides properties that describe user authorization to a workspace.

contentTypestringOptional

createdstringOptional

The UTC DateTime when the workspace user authorization was created.

createdByIdstringOptional

createdByInformationobjectOptional

A workspaceUser representing the user. This property is only returned in response to user specific GET call.

extensionstringOptional

fileSizestringOptional

fileUristringOptional

idstringOptional

isPublicstringOptional

If true, this supersedes need for bit mask permission with workspaceUserAuthorization

lastModifiedstringOptional

Utc date and time the comment was last updated (can only be done by creator.)

lastModifiedByIdstringOptional

lastModifiedByInformationobjectOptional

A workspaceUser representing the user. This property is only returned in response to user specific GET call.

namestringOptional

pageCountstringOptional

parentFolderIdstringOptional

parentFolderUristringOptional

typestringOptional

Type of the user. Valid values: type_owner, type_participant.

uristringOptional

Errors

400

Bad Request Error