Skip to main content
PATCH
Patch File
Partial update — only the fields you send are changed (Pydantic exclude_unset, so null and “absent” are distinguishable).

Auth

Requires a CRM manage scope and an active organization on the token. Any *:manage scope qualifies — in practice contacts:manage, deals:manage, companies:manage, or activities:manage.

Response

Returns the updated files row (same shape as file in Initiate an Upload).

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

file_id
string
required

UUID of the file to update.

Body

application/json
display_name
string | null

Renames the file.

folder_id
string | null

Moves the file to this folder id.

tags
string[] | null

Replaces the file's tag list wholesale.

description
string | null

Replaces the file's description.

Response

Successful Response

The response is of type Response Patch File Files File Id Patch · object.