Update File

Update a file by ID.


PATCH
/files/{id}

Authorization

AuthorizationRequiredBearer <token>

See API Security for more details.

In: header

Request Body

application/jsonRequired

The request body should contain a properly formatted JSON object. Optional properties are listed below. See File Object for more details.

folderstring
filenamestring
refstring
metadataobject

Path Parameters

idRequiredstring

Response Body

Success

TypeScript Definitions

Use the response body type in TypeScript.

metaobject
dataobject
errorobject | null | null
linksobject
const body = JSON.stringify({
  "folder": "updated/folder",
  "filename": "new_filename.mp4",
  "metadata": {
    "customKey2": "a different custom value"
  }
})

fetch("https://api.ittybit.com/files/file_abcdefgh1234", {
  headers: {
    "Authorization": "Bearer <token>"
  },
  body
})
{
  "meta": {
    "request_id": "req_abcdefghij1234567890",
    "org_id": "org_abcdefgh1234",
    "project_id": "prj_abcdefgh1234",
    "version": "2025-01-01",
    "type": "object"
  },
  "data": {
    "id": "file_abcdefgh1234",
    "media_id": "med_abcdefgh1234",
    "object": "source",
    "kind": "video",
    "type": "video/mp4",
    "width": 1920,
    "height": 1080,
    "duration": 123.45,
    "filesize": 12345678,
    "folder": "updated/folder",
    "filename": "new_filename.mp4",
    "url": "https://you.ittybit.net/updated/folder/new_filename.mp4",
    "metadata": {
      "customKey2": "a different custom value"
    },
    "created": "2025-01-01T01:23:45Z",
    "updated": "2025-01-02T01:23:45Z",
    "status": "ready"
  },
  "error": null,
  "links": {
    "self": "https://api.ittybit.com/files/file_abcdefgh1234",
    "parent": "https://api.ittybit.com/files"
  }
}