Quatrix APIs v1.0
Space shortcuts
Quatrix APIs v1.0 QA1

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Response formatsJSON
Requires authentication?Yes
HTTP MethodPOST
Response code202

Parameters

 

Name TypeDefault ValueValidationDescription

id

required

uuid-uuid4

the ID of instant share object using which you want to share

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

Code Block
languagejs
{"job_id": <uuid>}

 

 

 

Quatrix APIs v1.0 QA1