Skip to main content
PATCH
/
v1
/
entities
/
{entityTypeName}
/
{entityId}
/
files
/
{fileId}
Update a File
curl --request PATCH \
  --url https://api.us.lexful.app/v1/entities/{entityTypeName}/{entityId}/files/{fileId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "property_name": "<string>",
  "is_public": true,
  "data": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "original_name": "<string>",
  "file_extension": "<string>",
  "mime_type": "<string>",
  "size": 123,
  "is_public": true,
  "s3_key": "<string>",
  "upload_status": "pending",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "property_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer token

​
X-Account-ID
string
header
required

Account ID

Path Parameters

​
entityTypeName
string
required

Entity type name

​
entityId
string<uuid>
required

Entity ID

​
fileId
string<uuid>
required

File ID

Body

application/json
​
name
string

File name

Minimum string length: 1
​
property_name
string

Property name

​
is_public
boolean

Whether file is publicly accessible

​
data
object

Additional metadata

Response

Default Response

​
id
string<uuid>
required

File unique identifier

​
organization_id
string<uuid>
required

Organization ID

​
name
string
required

File name

​
original_name
string
required

Original filename

​
file_extension
string
required

File extension (e.g., .pdf, .jpg)

​
mime_type
string
required

MIME type

​
size
number
required

File size in bytes

​
is_public
boolean
required

Whether file is publicly accessible

​
s3_key
string
required

S3 storage key

​
upload_status
enum<string>
required

Upload status

Available options:
pending,
uploading,
completed,
failed
​
entity_id
string<uuid> | null

Associated entity ID

​
property_name
string | null

Associated property name

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
created_by
string

User ID who created

​
updated_by
string

User ID who last updated

​
data
object

Additional metadata