This API call is used to send share email message.
Resource URL
/api/1.0/share/send
Resource Information
Response formats | JSON |
Requires authentication? | Yes |
HTTP Method | POST |
Response code | 202 |
Parameters
Name | Type | Default Value | Validation | Description |
folder_id required | uuid | - | uuid4 | the ID of the folder that contains files you want to share |
files required | uuid[] | - | uuid4[] | specifies the list of file IDs you want to share |
contacts required | uuid[] | - | uuid4[] | specifies the list of recipient IDs that you want to share |
subject optional | string | '' | length[1, 500] | text of the email subject |
message optional | string | '' | length[0, 10000] | text of the email message |
expires optional | timestamp | 0 | timestamp | contains UTC time when the sharing files/folders expire. if it is set as <0>, it will never expire. |
activates optional | timestamp | 0 | specifies UTC time when the sharing files/folders are activated. If it is set as <0>, it will be instantly activated. | |
return_files optional | bool | false | - | enables to return files. |
pgp_encrypted optional | bool | false | - | shows that files were PGP encrypted. |
return_pgp_encrypted optional | bool | false | - | specifies that returned files should be PGP encrypted. It can only be true, if 'return_files' is true. |
message_signature optional | string | '' | length[0, 500] | email signature text |
notify optional | bool | false | - | enables notifications which are sent after downloading files. |
share_type optional | string<'P'|'T'|'C'> | 'T' | - | the type of share |
Add Comment