Zapmail
Overview
API Reference
Overview
API Reference
Sign In
Subscriptions and Workspaces
Copy Page
Domains
DNS
Get DNS Records
Add DNS Records
Check DNS Records
Add DNS Records to Multiple Domains
Update DNS Record
Delete DNS Record
Register
Search Available Domains
Buy Domains
Check Availability of Multiple Domains
Find Domains With AI
Connect
List Domain Connection Requests
Connect Domains
Get Nameservers to Connect a Domain
Verify Nameservers to Connect a Domain
Add Google Client ID to Domains
Remove Domain Connection Requests
Tag
List Domain Tags
Assign Tags to Domains
Create Domain Tags
Remove Tags from Domains
Delete Domain Tag
Update Domain Settings
Renewals
Search Domains Due for Renewal
Get Domain Renewal Prices
Renew Domains
Update Domain Auto-Renew
List Domains Due for Renewal
List Assignable Domains
GET
Get Domain Health Score
GET
Search Mailboxes and Domains
GET
List Domains
POST
Move Domains to Another Workspace
POST
Remove Connected Domains
DELETE
Mailbox
Get Authenticator Code
GET
Get Mailbox
GET
List Mailboxes
POST
Provision Mailboxes
POST
Update Mailboxes
PUT
Schedule Mailbox Removal
PUT
Retry Failed Mailboxes
PUT
Export
List Third-Party Workspaces
Add Sequencer Details
Get Export Status
Update Sequencer Account Details
Add Google Client ID To Domain
Connect Third-Party Account
Connect Mailboxes With Custom OAuth
Fetch Workspaces by App
Export Mailboxes
Update Third-Party Account
Get Export Status
Export Mailboxes
Quick Setup
List Quick Setup Entries
Start Quick Setup
Pre-Warmed
List Pre-Warmed Domains
Count Pre-Warmed Domains
List Pre-Warmed Subscriptions
Assign Pre-Warmed Domains
Purchase Pre-Warmed Plan
Zapbox
List Zapbox Connected Accounts
List Zapbox Threads
Get Zapbox Thread Messages
Search Zapbox Emails
Send Zapbox Email
Apply Zapbox Email Action
Download Zapbox Attachment
Create Zapbox Label
Delete Zapbox Label
Rename Zapbox Label
User
Get Current User
Billing Details
Add Billing Details
Update Billing Details
Payments & Wallet
Get Wallet Balance
Add Wallet Balance
Enable or Disable Auto Recharge
Buy Add-On Mailboxes
Get Subscription Invoice URL
Subscriptions and Workspaces
List Workspace Members
GET
List Workspace Invitations
GET
List Workspaces
GET
List Subscriptions
POST
Create Workspace
POST
Send Workspace Invitation
POST
Cancel Subscription
POST
List Subscription Mailboxes
POST
Update Member Role
PUT
Update Workspace
PUT
Revoke Workspace Access
DELETE
High Reputation Domains
List Aged Domains
Purchase Aged Domains
Deliverability
ZapShield
List ZapShield Subscriptions
List ZapShield Eligible Domains
List ZapShield Allocated Domains
Get ZapShield Available Slots
Cancel ZapShield Subscription
Purchase ZapShield
Upgrade ZapShield Plan
Allocate Domains to ZapShield
Deliverability Test
Get Deliverability Test Overall Report
List Deliverability Test Orders
Get Deliverability Test Report
List Deliverability Test Subscriptions
Get Deliverability Test Available Slots
List Deliverability Test Eligible Mailboxes
Purchase Deliverability Test
Generate Deliverability Test Spintax
Purchase Deliverability Test Plan
Cancel Deliverability Test Subscription
AI Insight
Get AI Insight Credits
Get AI Insight Analysis
Get Shared AI Insight Analysis
List AI Insight Eligible Mailboxes
Generate AI Insight Analysis
Calculate AI Insight Pricing
Purchase AI Insight Plan
Purchase AI Insight For Mailboxes
Email AI Insight Analysis
Share AI Insight Analysis
List AI Insight Analyses
Upgrade AI Insight Plan
Zap Care
List Zap Care Allocated Domains
Get Zap Care Available Slots
List Zap Care Subscriptions
List Zap Care Eligible Domains
Cancel Zap Care Subscription
Allocate Domains to Zap Care
Purchase Zap Care
Webhooks
List Webhook Event Types
List Webhook Endpoints
List Webhook Deliveries
Get Webhook Endpoint
Create Webhook Endpoint
Resend Webhook Delivery
Send Test Webhook Event
Update Webhook Endpoint
Delete Webhook Endpoint
Zap Sites
Get Zap Site
Create Zap Site
Regenerate Zap Site
Deploy Zap Site
Scan Zap Site Destination
Update Zap Site
Zapwarm
List mailboxes eligible for warmup
Get the Zapwarm quote for selected mailboxes
Start Zapwarm on selected mailboxes
Turn off Zapwarm on selected mailboxes
Edit Zapwarm settings
Get zapwarm score
ZapPulse
Get ZapPulse Overview
Get ZapPulse Insights
List ZapPulse Mailboxes
Get ZapPulse Mailbox Report
Create ZapPulse Report Share Link
Subscriptions and Workspaces
Copy Page
Update Workspace
PUT
https://api.zapmail.ai/api/v3
/workspaces
Try it
Run in Apidog
Run in Apidog
Renames a workspace and can update its billing details in the same call.
The workspace must be owned by the account the API key belongs to; otherwise 404.
Names must be unique per owner; a name used by another workspace returns 409.
When
billingDetails
is sent it is saved the same way as Update Billing Details.
Related: Create Workspace, List Workspaces.
Request
Header Params
Generate Code
Body Params
application/json
Required
Generate Code
Examples
Responses
🟢
200
Success
application/json
Success
Body
application/json
Generate Code
ðŸŸ
401
Unauthorized
ðŸŸ
403
Forbidden
ðŸŸ
404
NotFound
ðŸŸ
409
Conflict