file

Update a file's metadata

patch/v1/org/{orgId}/file/{fileId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/file/{fileId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

fileIdstring required

File id

Request body

fieldIdstring

field that the file uses, if the file is tied to a field

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

level of sensitivity of the file, if the file is not tied to a field

filenamestring

customer facing filename of file

metadataobject

Optional metadata about the file

Example request

{
  "fieldId": "offerLetter",
  "sensitive": "PERSONAL",
  "filename": "Offer Letter - Bob Smith.pdf"
}

Response

file deleted

Changes

No recorded changes to this operation across all 20 revisions of this API.