Delete Public Link

delete

/documents/api/1.1/publiclinks/{linkId}

Delete a specific public link.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

linkId

Type: string

Required: true

Globally unique identifier (GUID) for the public link.

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about the deleted public link.

Root Schema : PublicLinkDeleteResponse

The response body includes information about the deleted public link.

Properties

errorCode

Type: string

An error code of zero (0) indicates no errors.

linkID

Type: string

Globally unique identifier (GUID) for the public link.

type

Type: string

Item type publiclink.

Example application/json

{
    "linkID":"LD86738D81BB59C8FA9A9497T0000000000100000001",
    "type":"publiclink",
    "errorCode":"0"
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

Link ID is not found.

Examples

The following example deletes the specified public link.

DELETE .../publiclinks/LD86738D81BB59C8FA9A9497T0000000000100000001

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "linkID": "LD86738D81BB59C8FA9A9497T0000000000100000001",
    "type": "publiclink"
}