1. Files
Pibox public API
  • v1
    • Teams
      • Invite Member
      • Get File Statuses
      • Get Teams
    • Groups
      • Get Groups
      • Get Group Info
      • Create Group
    • Projects
      • Get Project Info
      • Create Project
      • Get Projects by Group
      • Get Non Group Projects
      • Get Chat History
      • Chat Message
    • Account
      • Get Account Info
    • Files
      • Find Files
      • Get File Info
      • Create Folder
      • Get Files by Folder
      • Get Folder URL
      • Update Folder Properties
      • Delete File
      • Upload from External Source
      • Generate Track Tags
      • File Upload
    • Tasks
      • Get Task Template
      • Load Tasks from Template
      • Get Tasks by Folder
      • Create Tasks
    • Webhooks
      • Create Webhook Endpoint
      • Get Webhook Endpoints
      • Delete Webhook Endpoint
  • Webhooks
    • file.uploaded
    • file.renamed
    • file.status_changed
    • task.closed
    • List webhook endpoints
    • Create a webhook endpoint
    • Delete a webhook endpoint
  • v2 (BETA)
    • AI agent
      • List the caller's active event subscriptions (newest first)
      • Subscribe to a user event (agent reminds the caller when it fires)
      • Cancel an event subscription
      • List the caller's scheduled agent tasks (soonest first)
      • Schedule the agent to run a task later (once / daily / weekly)
      • Cancel a scheduled agent task
    • Playlists
      • List the playlists in a team
      • Create a playlist in a team
      • Get a playlist, including its files
      • Rename a playlist
      • Delete a playlist
      • Add a file to a playlist
      • Remove a file from a playlist
    • Favorites & Recents
      • List the caller's favorites (pinned projects, groups and files)
      • Add a project, group or file to favorites
      • Remove a project, group or file from favorites
      • List items (files/projects) the caller recently accessed
    • Notifications
      • List the caller's notifications (newest first)
      • Get the caller's unread-notification counter
      • Mark all of the caller's notifications as read
      • Mark a single notification as read
    • File comments
      • List a file's comments
      • Leave a comment
      • Mark a file's comments as read
      • Export a file's comments
      • Edit a comment
      • Delete a comment
      • Reply to a comment
      • Toggle like on a comment
      • Resolve a comment (or reopen it with resolved=false)
    • Knowledge base
      • Search the Pibox Help Center
      • Get a Help Center article by id
      • Search the Pro Tools / audio-production knowledge base
    • Search
      • Global search
    • Accounts
      • Get an account profile (same organization)
    • Messages
      • Project chat history
      • Send a message (reply via parent_message_id)
      • Forward a message into this project
      • Mark all messages in the project chat as read
      • Edit a message
      • Delete a message
    • Metadata
      • Get a team's metadata template
      • Get a file's metadata
      • Get a file's custom metadata field values
      • Set the value of a custom metadata field on a file
      • Export a file's metadata (xlsx)
      • Export metadata for multiple files
    • Tasks
      • List task-list templates of a team
      • List tasks in a folder
      • Create tasks (inline list) or load from a template
      • Get a task
      • Update a task
      • Delete a task
      • Add items to a task
      • Delete a task item
    • Files
      • Find files in a team (optionally scoped to a group/project)
        GET
      • List a team's file-status options
        GET
      • List folder contents
        GET
      • Create a folder (mkdir) or import a file from a URL
        POST
      • Upload a file (streamed binary body)
        PUT
      • Generate AI track tags for files
        POST
      • Filter-search files across the caller's projects (name fuzzy match + audio-metadata filters)
        POST
      • Batch get file info (incl. media metadata + AI tags)
        POST
      • Generate an XLSX report from structured sheets; returns a download URL
        POST
      • Get file info (incl. media metadata + AI tags)
        GET
      • Update file properties
        PATCH
      • Delete a file
        DELETE
      • Deep-link URL to a folder in the app
        GET
      • Resolve a file's download URL
        GET
      • List a file's versions
        GET
      • Copy a file into another folder
        POST
      • Move (or rename) a file
        POST
      • Set (or clear) a file's review status
        POST
      • Set a free-form label on a file version
        PATCH
    • Projects
      • List team projects (non-grouped)
      • Create a project under a team
      • Members across the team's projects
      • List projects of a group
      • Create a project in a group
      • Get a project
      • Update a project (rename / privacy / avatar)
      • Delete a project
      • Add a member (by account_id) or invite one (by email)
      • Remove a member from the project
      • Cancel a pending project invitation (by email)
      • Batch get project info
      • List ungrouped projects for one or more teams
      • List projects for one or more groups
      • Search projects by name (fuzzy), optionally scoped to a team/group
    • Groups
      • List groups of a team
      • Create a group in a team
      • Get a group
      • Update a group
      • Delete a group
      • Move an existing project into the group
      • Batch get group info
      • List groups for one or more teams
      • Search groups by name (fuzzy), optionally scoped to a team
    • Teams
      • List the caller's teams
      • Get a team (incl. members and pending members)
      • Add an existing account to the team
      • Change a member's role
      • Remove a member from the team
      • Cancel a pending invitation (by email)
      • Invite a member to a team
      • Caller's role capabilities and plan limits in a team (incl. remaining AI credits)
    • OAuth
      • Authorization-server metadata (RFC 8414)
      • Consent page (issues an authorization code)
      • Confirm consent (api_token bridge) → 302 with code
      • Exchange code (PKCE) or refresh_token for tokens
      • Revoke an access or refresh token (RFC 7009)
      • Dynamic client registration (RFC 7591)
    • team
      • Get Teams (GET)
  • Schemas
    • v1
      • Team
      • Track Info
      • Video Info
      • Image Info
      • AI Tags
      • Empty Schema
    • FileStatus
    • Error
    • ListEnvelope
    • ObjectEnvelope
    • TokenResponse
    • ClientRegistration
    • AuthServerMetadata
  1. Files

Update file properties

PATCH
https://api.pibox.com/api/v2/files/{fileId}

Request

Path Params

Body Params application/json

Examples

Responses

🟢204No Content
Updated
This response does not have a body.
🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.pibox.com/api/v2/files/' \
--header 'Content-Type: application/json' \
--data '{
    "removal_protection": true,
    "task_load_protection": true
}'
Response Response Example
{
    "error": {
        "code": "string",
        "message": "string"
    }
}
Modified at 2026-08-05 12:46:23
Previous
Get file info (incl. media metadata + AI tags)
Next
Delete a file
Built with