74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
---
|
|
name: email-domains-routes
|
|
description: Handle 6 OpenAPI operation(s) under /api/v1/email-domains for the email domains route group.
|
|
---
|
|
|
|
# email domains API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /api/v1/email-domains for the email domains 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
|
|
|
|
### list_email_domains
|
|
|
|
- Operation ID: `list_email_domains`
|
|
- Route: `GET /api/v1/email-domains`
|
|
- Mode: READ
|
|
- Summary: List all email domains
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
|
|
### create_email_domain
|
|
|
|
- Operation ID: `create_email_domain`
|
|
- Route: `POST /api/v1/email-domains`
|
|
- Mode: WRITE
|
|
- Summary: Create an email domain
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_email_domain
|
|
|
|
- Operation ID: `get_email_domain`
|
|
- Route: `GET /api/v1/email-domains/{emailDomainId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an email domain
|
|
- Parameters:
|
|
- `emailDomainId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### replace_email_domain
|
|
|
|
- Operation ID: `replace_email_domain`
|
|
- Route: `PUT /api/v1/email-domains/{emailDomainId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an email domain
|
|
- Parameters:
|
|
- `emailDomainId` in `path` required
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_email_domain
|
|
|
|
- Operation ID: `delete_email_domain`
|
|
- Route: `DELETE /api/v1/email-domains/{emailDomainId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an email domain
|
|
- Parameters:
|
|
- `emailDomainId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### verify_email_domain
|
|
|
|
- Operation ID: `verify_email_domain`
|
|
- Route: `POST /api/v1/email-domains/{emailDomainId}/verify`
|
|
- Mode: WRITE
|
|
- Summary: Verify an email domain
|
|
- Parameters:
|
|
- `emailDomainId` in `path` required
|