Skip to main content

Update file metadata

Update file metadata

Path Parameters
fileId uuid REQUIRED
Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

Request Body REQUIRED
flags string[]

Possible values: [API_DOCUMENTATION, OPEN_API_SPECIFICATION]

File flags to set. Must be chosen from the file's availableFlags.

name string

Possible values: length ≤ 50

Responses
200

File successfully updated

Schema OPTIONAL
availableFlags string[] OPTIONAL

Possible values: [API_DOCUMENTATION, OPEN_API_SPECIFICATION]

categoryId uuid OPTIONAL
contentType string OPTIONAL
createdAt date-time OPTIONAL
createdBy uuid OPTIONAL
flags string[] OPTIONAL

Possible values: [API_DOCUMENTATION, OPEN_API_SPECIFICATION]

id uuid OPTIONAL
name string OPTIONAL
ownedBy uuid OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, CONTACT, ORGANIZATION, PRODUCT, PLAN, CONNECTED_PRODUCT, USER, FILE, TECHNICAL_USER, CONSUMER, INVITATION, USER_ROLES, TEAM, PLATFORM_ADMIN, BUNDLE, FOLDER]

sharedWith uuid OPTIONAL
size int64 OPTIONAL
url string OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL