GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Change file information/properties

patch
https://api.seismic.com/integration/v2/teamsites//files/

Updates metadata for a single Library file in a teamsite. Use this endpoint to move a file to another folder, change ownership, update custom properties, set an expiration date, or modify expert assignments. The request body follows the same shape as the GET response, so callers can GET the file, modify the desired fields, and PATCH the result back.

Body Field Definition

  • name: The name of the file.
  • parentFolderId: The GUID of the file's parent folder. Changing this value will move the file from one folder to another. Use "root" to place files in the root folder of the teamsite.
  • ownerId: The userId of the owner of the file.
  • experts: A list of experts for this file. A user expert would be in the form {"type":"user", "id":"the users id"}. A group expert would be in the form {"type":"group", "id":"the group id"}.
  • description: The description for the file.
  • expiresAt: The date the file expires which can only be set to the future. This date does not accept the time component, so should be specified as a UTC YYYY-MM-DD.
  • properties: An array of properties and their values where each property is identified by its id such as {"id": "the property id","values": ["Value A", "Value B"]}. The property name can be included, but will be ignored.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as 1.

uuid
required

Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.

Query Params
boolean
Defaults to true

When true, the response body contains the full updated file metadata payload (the same shape as the GET file endpoint). When false, the service returns an empty 200 response — useful when the caller does not need the updated metadata and wants to minimize bandwidth on bulk patch workflows. Defaults to true.

Body Params

JSON object containing the file properties to update. Include only the fields you want to change; omitted fields remain unchanged.

Request body for updating Library file metadata. Patch semantics — include only the fields you want to change; omitted fields remain unchanged. Field-level validation rules match the create-file endpoint.

string
length between 1 and 255

Display name of the file as shown in Library navigation and search results. When supplied, the new name should include the appropriate file extension; the service will not auto-append one.

string

Identifier of the destination parent folder. Use root to move the file to the top level of the teamsite, otherwise provide a folder UUID. When supplied, the file is moved to the new parent.

string

Identifier of the user to whom file ownership should be transferred (semantically userId). May be 1 or 2 for built-in accounts or a UUID for a tenant user. Only callers with appropriate permissions may reassign ownership.

string
length ≤ 255

Optional external identifier used to correlate this file with a record in an external system (such as a CRM or DAM). Set to empty string to clear an existing external mapping.

string
length ≤ 255

Optional external connection identifier associated with the externalId mapping source. Used to disambiguate when the same external id exists across multiple integrations.

experts
array of objects

Replacement list of experts (subject-matter contacts) for the file. When supplied, the entire experts collection is replaced with the new list. Each entry includes the principal id and type (user or group).

experts
string
length ≤ 4000

Free-text description shown to Library consumers. Set to empty string to clear an existing description.

date

The date the file expires, in YYYY-MM-DD format. Must be a future date. Set to null or empty string to remove an existing expiration.

properties
array of objects

Replacement list of custom property value assignments. When supplied, the entire properties collection is replaced; properties not included in the array are cleared on the file.

properties
Headers
string

MIME type header for the request payload. For this operation, send application/json.

string
enum
Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:
Responses

Updated 16 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8
application/json

Updated 16 days ago