Show/Hide Toolbars

Creates a hyperlink in a given parent folder. The hyperlink category is set to a specified Document category.

Parameters

createHyperlink Parameter Descriptions

Parameter Name

Data Type

Description

parentUniqueKey

string

Unique key of the folder to create a subfolder within.

url

string

The website URL that the hyperlink will link to.

name

string

Name of the hyperlink. For example, in the application UI, the hyperlink name displays but the URL does not.

documentCategoryUniqueKey

string

Unique key of the existing Document category to set as the hyperlink category.

contactUniqueKey

string

Unique key of the contact record for the contact who creates the hyperlink.

Response

createHyperlink Response Descriptions

Parameter Name

Data Type

Description

uniqueKey

string

The unique key of the hyperlink.