Jump to

• Request
• Response
• Examples

Delete Public Link

delete

/documents/api/1.2/publiclinks/{linkId}

Delete a specific public link.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• linkId: string
  Globally unique identifier (GUID) for the public link.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : PublicLinkDeleteResponse

Type: object

The response body includes information about the deleted public link.

Show Source

• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• linkID(optional): string
  Globally unique identifier (GUID) for the public link.
• type(optional): string
  Item type publiclink.

{
    "description":"The response body includes information about the deleted public link.",
    "properties":{
        "linkID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the public link."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>publiclink</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Example Response (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.

Back to Top

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"
}

Back to Top