Delete a file share 

Delete a file share programmatically.

Only the owner of a file can delete shares from that file.

See Authenticating requests for information about how to authenticate the request.

Table 1. Atom API request details

Method URI Input and output representations
DELETE /basic/api/shares/feed?sharedWhat={document-id} none


Note: {document-id} is the value of the <td:uuid> element in the file's Atom entry document.

You can use the following header.

Table 2. Input header

Parameter Description
X-Method-Override Tunnels a DELETE request over HTTP POST

You can use one or more of these input parameters. Separate multiple parameters with an ampersand (&).

Table 3. Input parameters

Parameter Description
sharedWhat

Note: This is a required parameter.

String. Document uuid. Delete a set of share resources for the specified document. 
sharedWith User ID of the user with whom the document has been shared, but you would like to prevent from having access to it. You can specify more than one person. Separate multiple user IDs with a comma. Any share resources for the document that have the specified users as targets of the share will be deleted. The default is to delete the document's shares with all users.


Input

None.


Output

None.

Returned HTTP headers

HTTP/1.1 204 No Content

Error codes


Parent topic

Work with shares

Related reference
Share content


   

 

});

+

Search Tips   |   Advanced Search