Change url information/properties

patch

https://api.seismic.com/integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}

Updates one or more metadata properties on an existing Library URL item identified by libraryContentId within the specified teamsite. Modifiable fields include system properties such as name, parentFolderId, description, owner, expiration date, and custom properties, as well as URL-specific fields such as the target URL and open-in-new-window flag.

The request body follows the same structure returned by the corresponding GET endpoint, so callers can retrieve the current metadata, modify relevant fields, and send the updated body via PATCH. Only the fields included in the request body are updated; omitted fields remain unchanged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

teamsiteId

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.

libraryContentId

uuid

required

Identifier of the library content item targeted by the operation. Must identify URL content for this endpoint.

Query Params

includeResponse

boolean

Defaults to true

When true, the response body contains the full updated URL metadata payload (the same shape as the GET URL 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 body containing the URL metadata fields to update. Only included fields are modified; omitted fields remain unchanged.

Request body for updating one or more metadata properties on an existing Library URL content item. Only included fields are modified; omitted fields remain unchanged.

name

string

The name of the URL content item.

parentFolderId

string

The identifier of the destination parent folder. Changing this value moves the URL content item to a different folder. Use root to place the item in the root folder of the teamsite.

externalId

string

An optional external identifier for the URL content item, used for integration with external systems.

externalConnectionId

string

An optional external connection identifier for the URL content item, used for integration with external systems.

experts

array of objects

A list of experts for this URL content item. Each expert identifies a user or group principal.

experts

description

string

The description for the URL content item. Can be an empty string to clear the description.

expiresAt

date

The date the URL content item expires, in YYYY-MM-DD format. Only future dates are accepted.

properties

array of objects

An array of custom properties and their values, where each property is identified by its id.

properties

url

object

URL-specific metadata fields for the Library URL content item.

Headers

Content-Type

string

Media type of the request body. Must be application/json for this endpoint.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. Returns the updated metadata for the URL content item after applying the requested changes.

400Bad Request. The teamsiteId is malformed, the libraryContentId does not identify URL content, or the request body contains invalid field values

401Unauthorized. The request is missing a bearer token, or the token is invalid or expired.

403Forbidden. The caller is authenticated but does not have permission to modify this URL content item.

404Not Found. The targeted teamsite, folder, file, item, or workflow could not be located by the provided identifier.

500Internal Server Error. An unexpected server-side error occurred while processing the request.

504Gateway Timeout. The upstream service did not respond in time, or is temporarily unavailable. Safe to retry after a brief delay.