Schemas

Introduction
Order
- Place Order
  POST
Webhook
- Status Change Webhook
  POST
Account
- Get account details
  GET
Workspaces
- List workspaces
  GET
- Get workspace details
  GET
- Create workspace
  POST
- Update workspace
  PUT
- Delete workspace
  DELETE
- Update workspace webhook
  POST
Domains
- Search available domains
  POST
- Check if domain is banned from registration
  GET
- Check domain availability
  GET
- Register domains
  POST
- List domains
  POST
- List assignable domains
  GET
- Remove domains
  POST
- Set domain forwarding
  POST
- Set catch-all email
  POST
- Remove catch-all email
  DELETE
- Get nameservers for domain connection
  POST
- Check nameservers propagation
  POST
- Check Workspace Availability
  POST
- Set DMARC Configuration
  POST
- Remove DMARC Configuration
  DELETE
- Regenerate Domain Nameservers
  POST
Cloudflare Domains
- Connect Cloudflare Domains
- List Connected Cloudflare Domains
- Get Domain Details
- Disconnect Cloudflare Domains
- List Cloudflare Zones
Mailboxes
- List mailboxes
- Add or update signature for mailboxes
- Delete signature for mailboxes
- Show mailbox credentials
- Get mailbox details
- Buy mailboxes
- Check mailbox status
- Cancel mailboxes
- Update mailbox
- Update mailbox profile picture
- Generate TOTP
- Change username
- Change password
- Check mailbox availability
- Get Failure Reason
- Uncancel mailboxes
DNS
- Get DNS records
- Add DNS records
- Update DNS records
- Delete DNS records
Sequencers
- Export mailboxes status
- List sequencer platforms
- Get sequencer tags
- List sequencers
- Export mailboxes
- Add sequencer
- Update sequencer
- Delete sequencers
Billing
- Get pricing plans
- Get subscription details
- Change subscription plan
- Cancel subscription
- Get wallet details
- Add credits to wallet
- Update auto top-up settings
- Get billing portal link
Warmup
- List Warmup Subscriptions
- Get Warmup Subscription Details
- Add Warmup to Mailboxes
- Pause Warmup for Mailboxes
- Resume Warmup for Mailboxes
- Cancel Warmup for Mailboxes
- Get Warmup Statistics
- Get Warmup Pricing
Client ID Requests
- Initiate Client ID Request
- Get Client ID Request Status
- List Client ID Requests
Mailbox Forwarding
- Setup Email Forwarding
- Update Email Forwarding
- Remove Email Forwarding
- List Forwarding Jobs
Consent Request
- Initiate Consent Request
- Get Consent Request Status
- List Consent Requests
Tags
- Assign tags to domains or mailboxes
- Get all tags
- Create a new tag
- Delete a tag
Prewarm
- Search Domains
- Search Mailboxes
- Buy Prewarmed Mailboxes
- Check Order Status
- Check Availability
Inbox Placement
- Tests
- Scheduled Tests
InfraGuard
- InfraGuard - Subscriptions
- InfraGuard - Monitoring
- InfraGuard - Settings
  - Update subscription settings
  - Trigger manual check
- InfraGuard - Alerts
- InfraGuard - Action Items
Email Insight
- Email Insights - Workspace
- Email Insights - Mailbox
Schemas
- Schemas

Schemas

WebhookResponse

{
    "success": true,
    "message": "string",
    "received_at": "2019-08-24T14:15:22.123Z"
}