Share

POST /object/send

Create a Share.

Parameters: No parameters

Request body:

The request body must contain an object representing the Share to create. Use "type":0 to indicate text and provide the "text":{} object.

Example:

{
"name": "My share",
"notes": "Note values",
"type": 0,
"text": {
"text": "Test text",
"hidden": true
},
"file": null,
"maxAccessCount": 5,
"deletionDate": "2023-05-20T9:05:31.810Z",
"expirationDate": "2023-05-20T19:06:53.810Z",
"password": "Password",
"disabled": false,
"hideEmail": true
}

Request URL examples:

https://domain.com

PUT /object/send/{id}

Edit an existing Share by specifying the unique object identifier in the path and the new object contents in the request body.

Parameters:

Request body:

The request body must contain an object representing the edits to make to the Share.

Include the full object in the request body , not just the properties to edit, as the new object will replace the pre-existing Share object.

Example:

{
"name": "My share",
"notes": "Note values",
"type": 0,
"text": {
"text": "Test text",
"hidden": true
},
"file": null,
"maxAccessCount": 5,
"deletionDate": "2023-05-20T9:05:31.810Z",
"expirationDate": "2023-05-20T19:06:53.810Z",
"password": "Password",
"disabled": false,
"hideEmail": true
}

Request URL examples:

GET /object/send/{id}

Retrieve a Share by specifying the unique object identifier in the path.

Parameters:

Request URL examples:

DELETE /object/send/{id}

Delete an existing Share by specifying the unique object identifier in the path.

Parameters:

Request URL examples:

GET /list/object/send

Retrieve a list of Shares. By default, this will return a list of all Share objects, however you can specify search terms as query parameters to narrow list results.

Parameters:

Request URL examples:

POST /send/{id}/remove-password

Remove the password from a Share.

Parameters:

Request URL examples: