Quatrix APIs v1.0
Space shortcuts
Quatrix APIs v1.0 QA1
Skip to end of metadata
Go to start of metadata

This API call is used to send share email message.

Resource URL

/api/1.0/share/send

Resource Information

 

Response formatsJSON
Requires authentication?Yes
HTTP MethodPOST
Response code202

Parameters

 

Name TypeDefault ValueValidationDescription

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

timestamp0timestamp

contains UTC time when the sharing files/folders expire. if it is set as <0>, it will never expire.

activates

optional

timestamp0

timestamp

specifies UTC time when the sharing files/folders are activated. If it is set as <0>, it will be instantly activated.

return_files

optional 

boolfalse-

enables to return files.

pgp_encrypted

optional

boolfalse-

shows that files were PGP encrypted.

return_pgp_encrypted

optional

boolfalse-

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 

boolfalse-

enables notifications which are sent after downloading files.

share_type

optional

string<'P'|'T'|'C'>'T'-

the type of share


Example Request URL

Example Result

{"job_id": <uuid>}

 

 

 

  • No labels
Write a comment…
Quatrix APIs v1.0 QA1