Update File

Update a file by ID

Authorization

api_key

x-access-token<token>

In: header

Path Parameters

file_id*string

The ID of the file to be updated

Request Body

application/json

The new values for the file

name?string

The name of the file

url?string

The URL of the file

mimetype?string

The mimetype of the file (application/pdf, etc.)

size?number

The size of the file in bytes

Formatdouble

thumbnail_url?|

URL for file thumbnail

file_category?APIFileCategory

Category of the file

Value in

"DOCUMENT"
"IMAGE"
"VIDEO"
"AUDIO"
"ARCHIVE"
"OTHER"

description?|

Optional file description

tags?array<string>

Tags for categorization

processing_status?APIFileProcessingStatus

Processing status for thumbnail generation

Value in

"PENDING"
"PROCESSING"
"COMPLETE"
"FAILED"

Response Body

`application/json`

`application/problem+json`

curl -X PATCH "https://example.com/shipos/files/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "tags": [    "string"  ],  "team_id": "string",  "processing_status": "PENDING",  "description": "string",  "file_category": "DOCUMENT",  "preview_blur_hash": "string",  "thumbnail_url": "string",  "size": 0.1,  "mimetype": "string",  "url": "string",  "name": "string",  "updated_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "id": "string"}

Update File

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

429application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`