headless lms

Set a file's display name within a download

PATCH /api/downloads/{downloadId}/assets/{assetId}. Set a file's display name within a download. Headless LMS Content API reference.

PATCH
/api/downloads/{downloadId}/assets/{assetId}

Requires downloads:write. Null falls back to the filename. Returns the download's files.

Path Parameters

downloadId*string
assetId*string

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/downloads/string/assets/string" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string"  }'
[  {    "orgId": "string",    "id": "string",    "downloadId": "string",    "assetId": "string",    "seq": -9007199254740991,    "displayName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "filename": "string",    "contentType": "string",    "size": 0,    "url": "string"  }]
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}