137 lines
3.5 KiB
Markdown
137 lines
3.5 KiB
Markdown
---
|
|
name: emails-routes
|
|
description: Handle 12 OpenAPI operation(s) under /emails for the emails route group.
|
|
---
|
|
|
|
# emails API Routes
|
|
|
|
Handle 12 OpenAPI operation(s) under /emails for the emails route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### post_emails
|
|
|
|
- Operation ID: `post_emails`
|
|
- Route: `POST /emails`
|
|
- Mode: WRITE
|
|
- Summary: Send an email
|
|
- Parameters:
|
|
- `Idempotency-Key` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_emails
|
|
|
|
- Operation ID: `get_emails`
|
|
- Route: `GET /emails`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of emails
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_emails_email_id
|
|
|
|
- Operation ID: `get_emails_email_id`
|
|
- Route: `GET /emails/{email_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
|
|
### patch_emails_email_id
|
|
|
|
- Operation ID: `patch_emails_email_id`
|
|
- Route: `PATCH /emails/{email_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update a single email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
|
|
### post_emails_email_id_cancel
|
|
|
|
- Operation ID: `post_emails_email_id_cancel`
|
|
- Route: `POST /emails/{email_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel the schedule of the e-mail.
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
|
|
### post_emails_batch
|
|
|
|
- Operation ID: `post_emails_batch`
|
|
- Route: `POST /emails/batch`
|
|
- Mode: WRITE
|
|
- Summary: Trigger up to 100 batch emails at once.
|
|
- Parameters:
|
|
- `Idempotency-Key` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_emails_email_id_attachments
|
|
|
|
- Operation ID: `get_emails_email_id_attachments`
|
|
- Route: `GET /emails/{email_id}/attachments`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of attachments for a sent email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_emails_email_id_attachments_attachment_id
|
|
|
|
- Operation ID: `get_emails_email_id_attachments_attachment_id`
|
|
- Route: `GET /emails/{email_id}/attachments/{attachment_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single attachment for a sent email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
- `attachment_id` in `path` required
|
|
|
|
### get_emails_receiving
|
|
|
|
- Operation ID: `get_emails_receiving`
|
|
- Route: `GET /emails/receiving`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of received emails
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_emails_receiving_email_id
|
|
|
|
- Operation ID: `get_emails_receiving_email_id`
|
|
- Route: `GET /emails/receiving/{email_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single received email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
|
|
### get_emails_receiving_email_id_attachments
|
|
|
|
- Operation ID: `get_emails_receiving_email_id_attachments`
|
|
- Route: `GET /emails/receiving/{email_id}/attachments`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of attachments for a received email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_emails_receiving_email_id_attachments_attachment_id
|
|
|
|
- Operation ID: `get_emails_receiving_email_id_attachments_attachment_id`
|
|
- Route: `GET /emails/receiving/{email_id}/attachments/{attachment_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single attachment for a received email
|
|
- Parameters:
|
|
- `email_id` in `path` required
|
|
- `attachment_id` in `path` required
|