Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorbrackets
printablefalse

...

You can send the response of your API request by email. To do it, you must include the destination object in your request and set type to email like this:

Code Block
"destination": {
 "type":"email"
}

...

Parameter

Type

Description

email.to *required

String

Email address to which send the query results. It must be the address of a user in the domain.   

You can include several email addresses following this format:

"email.to":"user@devo.com, user2@devo.com"

email.subject

String

Specify the subject of the email.

email.maxNum

Integer

Add this parameter to set the maximum number of response emails that can be sent. If you don't add it, set it to 0 or to a negative number, you will get unlimited emails.

retention.size

Long

Maximum retention file size in kilobytes. If you don't add this parameter, the default retention size is 5MB.

retention.time

Long

Maximum retention time in seconds. If you don't add this parameter, the default retention time is 15 mins.

format

String

Indicate the format of the file sent. You can choose zip, gzip or plain. If you don't add this parameter, the default format file is zip.

file.password

String

Add a password for the compressed file. This is only valid for zip format.

email.fileName

String

Filename to be used for files sent via email.

...