The API was built with the intention of providing software engineers and businesses with a simple and easy to use solution to secure note/message sharing. Whether you're a developer writing an application that requires temporary but secure note sharing with end-to-end encryption and self-destruction(after being read), we can handle the heavy lifting of storing and the sharing of your notes so you don't have to worry about your notes.
Private note sharing API endpoint is pretty straightforward to use. All you need to do is perform a POST request on the main note endpoint using the following schema.
curl -X POST https://share-file.maildim.com/api/note \
-H "Content-Type: application/json" \
-d '{
"note": "this is a secret message",
"lifetime": "48",
"read_count": "10",
"password": "secret"
}'
Parameters:
| Attribute | Type | Required | Description |
|---|---|---|---|
note |
integer/string | yes | your private message or secret |
lifetime |
integer | no | the note lifetime in a number of hours. min: 1, max: 336 |
read_count |
integer | no | number of views before destructing the note |
password |
integer/string | no | a custom password for your note |
Sample API response
{
"success": true,
"key": "5dd3fd2299fa64@49618577",
"link": "https://share-file.maildim.com/r/5dd3fd2299fa64@49618577"
}
Sample error response
{
"success": false,
"error": "404",
"message": "not found"
}