provider CSV (UI only)V3 POST
/messages/download @utdk/sendgrid
/messages/download Request CSV
This is BETA functionality. You may not have access, and we reserve the right to change functionality without notice.
This request will kick off a backend process to generate a CSV file. Once generated, the worker will then send an email for the user download the file. The link will expire in 3 days.
The CSV fill contain the last 1 million messages. This endpoint will be rate limited to 1 request every 12 hours (rate limit may change).
This endpoint is similar to the GET Single Message endpoint - the only difference is that /download is added to indicate that this is a CSV download requests but the same query is used to determine what the CSV should contain.
- query query
- Uses a SQL like syntax to indicate which messages to include in the CSV
- string
- Authorization header required
- string
Try it
Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import sendgrid from '@utdk/sendgrid';
await sendgrid.postV3MessagesDownload({
"Authorization": "Bearer <<YOUR_API_KEY_HERE>>"
})