Update Doc

Rename a doc, move it to another folder, or both. Pass `folderId: null` to move the doc to the workspace top level. Provide at least one of `name` or `folderId`.

PATCH/api/v1/docs/{fileId}

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys.

In: header

Path Parameters

fileId*string

The doc ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/docs/string" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string"  }'
{  "success": true,  "data": {    "doc": {      "id": "string",      "name": "string",      "size": 0,      "type": "string",      "key": "string",      "uploadedBy": "string",      "uploadedAt": "2019-08-24T14:15:22Z",      "folderId": "string"    }  }}