Add a URL

Adds a new URL content item to a Library teamsite using an application/json POST with all required information in the POST body. The request body must include a name, parentFolderId, and a url object with the target URL string.

This endpoint also supports sending all metadata that would otherwise be sent in the PATCH operation to the /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId} endpoint, such as experts, properties, expiresAt, and description.

You can optionally include an externalId as a well-known, non-editable identifier for tracking the content item from an external system, along with an externalConnectionId to identify the source connection.

On success the response returns the full metadata of the newly created URL content item, including its generated id, versionId, audit timestamps, and all supplied metadata fields.

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.

Body Params

JSON object containing the URL content metadata to create.

Request body for creating a new URL content item in a Library teamsite. URL content items are managed link resources with their own metadata, permissions, and audit fields.

string
required
length between 1 and 255

The display name of the URL content item shown in Library navigation, search results, and integration surfaces.

string
required

The identifier of the destination parent folder. Use root to place the URL at the top level of the library, otherwise provide a folder UUID.

string
length ≤ 255

Optional external identifier used to correlate this URL with a record in an external system (such as a CRM or DAM). Provide a value when the URL was created in response to an external trigger.

string
length ≤ 255

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

experts
array of objects

An array of experts (subject matter experts) to associate with the URL content item. Each expert has an id and a type (user or group) and is surfaced to consumers seeking subject expertise on the linked content.

experts
string
length ≤ 4000

Optional free-text description shown to Library consumers. Supports brief context about what the linked URL contains and how to use it. May be empty.

date

Optional expiration date in YYYY-MM-DD format. After this date the URL is treated as expired in consumer surfaces. Must be a future date when set.

string

Content format indicator. Typically Url for URL content items; included for parity with file/folder format fields and for downstream rendering hints.

properties
array of objects

An array of custom properties to assign to the URL content item. Each property is identified by its id and includes an array of values.

properties
url
object
required

An object containing the URL string and its display behavior.

Headers
string

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

Responses

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