Skip to main content
PUT
/
api
/
v3
/
files
/
{fileId}
Update file info.
curl --request PUT \
  --url https://apix.us.amity.co/api/v3/files/{fileId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileId": "<string>",
  "isUsed": true,
  "altText": "<string>",
  "status": "uploading",
  "videoUrl": "<string>",
  "thumbnailFileId": "<string>",
  "metadata": {}
}'
{
  "status": "<string>",
  "data": [
    {
      "fileId": "<string>",
      "type": "image",
      "accessType": "public",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
fileId
string
required

File id

Maximum length: 50

Body

application/json

information of a file to be updated.

​
fileId
string
required

The ID of the file to be updated.

​
isUsed
boolean

Indicates if the file is currently in use.

​
altText
string

Alternative text for the file.

​
status
enum<string>

The status of the file.

Available options:
uploading,
done,
error,
removed
​
videoUrl
string

URL of the video if applicable.

​
thumbnailFileId
string

The ID of the thumbnail file.

​
metadata
object

Metadata associated with the file. Do not provide isFull key as it is reserved for internal use and this metadata field is limited to 5kb.

Response

File Upload Result

​
status
string
​
data
object[]