{ "schemes": ["https"], "swagger": "2.0", "info": { "description": "Primeforge Public API for managing domains, mailboxes, and workspaces.", "title": "Primeforge API", "termsOfService": "https://www.primeforge.ai/terms", "contact": { "name": "Primeforge Support", "url": "https://www.primeforge.ai/support", "email": "support@primeforge.ai" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0" }, "host": "api.primeforge.ai", "basePath": "/public", "paths": { "/check-domain-availability": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Check if a single domain is available for purchase", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Check Domain Availability", "parameters": [ { "type": "string", "description": "Domain to check (e.g. example.com)", "name": "domain", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.ExternalCheckDomainAvailabilityResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve all domains associated with the API Key account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "List Domains", "parameters": [ { "type": "integer", "description": "Pagination limit", "name": "limit", "in": "query" }, { "type": "integer", "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "string", "description": "Workspace ID to filter by", "name": "workspaceId", "in": "query" }, { "type": "string", "description": "Search domains by name or ID", "name": "search", "in": "query" } ], "responses": { "200": { "description": "List of domains", "schema": { "$ref": "#/definitions/responses.PaginatedResponse-responses_DomainResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Buy domains and add them to the workspace.\n\n**Phone format:** `contactDetails.phone` must be in E.164-compatible format including country code (e.g. `+18134682910`). A number without a country code will be rejected.\n\n**Async registration:** A `202 Accepted` response means the purchase has been recorded and payment charged. Actual domain registration with the registrar happens asynchronously, triggered by a Chargebee payment webhook. Use `GET /public/setups/{id}` (where `id` is `setup.id` from this response) to poll registration status.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Buy Domains", "parameters": [ { "description": "Domains to buy", "name": "domainsToBuy", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.BuyDomainRequest" } } ], "responses": { "202": { "description": "Purchase recorded — domain registration is initiated asynchronously", "schema": { "$ref": "#/definitions/responses.BuyDomainResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "409": { "description": "Domain not available", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/bulk-disable-autorenew": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Bulk disable auto renew for the given domains", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Bulk disable domain auto renew", "parameters": [ { "description": "ExternalBulkEnableDisableAutoRenewRequest", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalBulkEnableDisableAutoRenewRequest" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request - no matching domains found or domains are not eligible for auto-renew", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/bulk-dns": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Update DNS records (DMARC, forwarding, CNAME) for multiple existing domains in bulk. The \"domains\" field must contain domain IDs (e.g. \"dom_...\") of domains that already exist in your account, as returned by GET /domains. This endpoint does NOT create or connect new/external domains; unknown IDs result in a 404.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Bulk Update DNS", "parameters": [ { "description": "Bulk DNS update details", "name": "bulkDNS", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalBulkUpdateDNSRequest" } } ], "responses": { "202": { "description": "DNS records update accepted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/bulk-enable-autorenew": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Bulk enable auto renew for the given domains", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Bulk enable domain auto renew", "parameters": [ { "description": "ExternalBulkEnableDisableAutoRenewRequest", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalBulkEnableDisableAutoRenewRequest" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request - no matching domains found or domains are not eligible for auto-renew", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/forwarding": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Set forwarding URL for multiple domains", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Set Domain Forwarding", "parameters": [ { "description": "Domain forwarding details", "name": "forwarding", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalSetDomainForwardingRequest" } } ], "responses": { "204": { "description": "Domain forwarding set successfully" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/search-available": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search for available domains with various filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Search Available Domains", "parameters": [ { "type": "string", "description": "Domain keyword to search for", "name": "domain", "in": "query", "required": true }, { "type": "boolean", "description": "Check Google Workspace availability", "name": "check_google_workspace", "in": "query" }, { "type": "boolean", "description": "Check Microsoft 365 availability", "name": "check_ms365_workspace", "in": "query" } ], "responses": { "200": { "description": "List of domains matching search criteria", "schema": { "$ref": "#/definitions/responses.DetailedDomainSearchResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/transfer": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Transfer existing domains into Primeforge. The domains stay registered with their\ncurrent registrar — Primeforge takes over their DNS.\n\n**No charge:** transferring a domain in is free. The workspace account must have an\nactive subscription, otherwise the request is rejected with `402`.\n\n**Async completion:** the response returns the nameservers the domains must be pointed\nat. Update them at your registrar; the domain becomes `active` once propagation is\ndetected. Use `GET /public/domains` to poll the status.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Transfer Domains", "parameters": [ { "description": "Domains to transfer", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalTransferDomainsRequest" } } ], "responses": { "200": { "description": "Nameservers to point the domains at", "schema": { "type": "array", "items": { "$ref": "#/definitions/responses.DomainTransferredNameserversResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "402": { "description": "Active subscription required", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{domainID}/disable-autorenew": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Disable auto renew for the given domain", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Disable domain auto renew", "parameters": [ { "type": "string", "description": "Domain ID", "name": "domainID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request - no matching domains found or domains are not eligible for auto-renew", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{domainID}/enable-autorenew": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Enable auto renew for the given domain", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Enable domain auto renew", "parameters": [ { "type": "string", "description": "Domain ID", "name": "domainID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request - no matching domains found or domains are not eligible for auto-renew", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve specific domain by its Id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Get Domain by Id", "parameters": [ { "type": "string", "description": "domain Id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Domain details", "schema": { "$ref": "#/definitions/responses.DomainResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Domain not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Schedule a domain for cancellation by its ID", "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Delete domain", "parameters": [ { "type": "string", "description": "Domain ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "Domain scheduled for cancellation" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{id}/cancel-deletion": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Cancel scheduled deletion for a single domain by its ID. Also clears scheduled\ndeletion on mailboxes belonging to the domain (scheduling domain deletion marks them all).", "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Cancel scheduled domain deletion", "parameters": [ { "type": "string", "description": "Domain ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Scheduled deletion cancelled", "schema": { "$ref": "#/definitions/responses.CancelMailboxesDeletionResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{id}/dns": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve DNS records for a specific domain by its Id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Get Domain DNS Records", "parameters": [ { "type": "string", "description": "domain Id", "name": "domainId", "in": "path", "required": true } ], "responses": { "200": { "description": "DNS details", "schema": { "type": "array", "items": { "$ref": "#/definitions/responses.DomainDNSResponse" } } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a new DNS record for a domain", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Create Domain DNS Record", "parameters": [ { "description": "Domain DNS record details", "name": "domainDNS", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.AddDNSRecordEARequest" } }, { "type": "string", "description": "Domain ID or Domain Name", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "DNS record created" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{id}/dns/{dnsId}": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Update a DNS record for a domain", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Update Domain DNS Record", "parameters": [ { "description": "Domain DNS record details", "name": "domainDNS", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.UpdateDNSRecordEARequest" } } ], "responses": { "204": { "description": "DNS record updated" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Delete a DNS record for a domain", "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Delete Domain DNS Record", "parameters": [ { "type": "string", "description": "Domain ID", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "DNS ID", "name": "dnsId", "in": "path", "required": true } ], "responses": { "204": { "description": "DNS record deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/domains/{id}/mailboxes": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create multiple mailboxes for a specific domain", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Create Mailboxes", "parameters": [ { "type": "string", "description": "Domain ID", "name": "id", "in": "path", "required": true }, { "description": "Mailbox creation request", "name": "createRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.CreateMailboxesForDomainRequest" } } ], "responses": { "201": { "description": "Mailboxes created successfully", "schema": { "$ref": "#/definitions/responses.CreateMailboxesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve all mailboxes associated with the API Key account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "List Mailboxes", "parameters": [ { "type": "integer", "description": "Pagination limit", "name": "limit", "in": "query" }, { "type": "integer", "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "string", "description": "Workspace Id to filter by", "name": "workspaceId", "in": "query" }, { "type": "string", "description": "Domain Id to filter by", "name": "domainId", "in": "query" }, { "type": "string", "description": "Mailbox email address to filter by", "name": "email", "in": "query" } ], "responses": { "200": { "description": "List of mailboxes", "schema": { "$ref": "#/definitions/responses.PaginatedResponse-responses_MailboxResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/get-by-addresses": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve mailboxes by email addresses for the API Key account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Get Mailboxes by Addresses", "parameters": [ { "description": "Mailbox addresses", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PublicGetMailboxesByAddressesRequest" } } ], "responses": { "200": { "description": "List of mailboxes", "schema": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/get-by-ids": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve mailboxes by IDs for the API Key account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Get Mailboxes by IDs", "parameters": [ { "description": "Mailbox IDs", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PublicGetMailboxesByIDsRequest" } } ], "responses": { "200": { "description": "List of mailboxes", "schema": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/adjust-mailbox-topup-amount": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "If mailbox slots topup amount is set, when running out of slots, the system will automatically topup the account with the given amount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credit Balance" ], "summary": "Adjust account mailbox topup amount", "parameters": [ { "description": "ExternalAdjustTopupAmountRequest", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.ExternalAdjustTopupAmountRequest" } } ], "responses": { "204": { "description": "Topup amount adjusted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/pre-warmed": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get available pre-warmed mailboxes", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Get Available Pre-Warmed Mailboxes", "responses": { "200": { "description": "List of pre-warmed mailboxes", "schema": { "type": "array", "items": { "$ref": "#/definitions/responses.PreWarmedMailboxResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Purchase pre-warmed mailboxes", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Purchase Pre-Warmed Mailboxes", "parameters": [ { "description": "Purchase pre-warmed mailboxes request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PurchasePreWarmedMailboxesRequest" } } ], "responses": { "204": { "description": "Pre-warmed mailboxes purchased" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve specific mailbox by its Id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Get Mailbox by Id", "parameters": [ { "type": "string", "description": "mailbox Id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Mailbox details", "schema": { "$ref": "#/definitions/responses.MailboxResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Mailbox not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Schedules mailbox deletion by its ID", "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Delete mailbox", "parameters": [ { "type": "string", "description": "Mailbox ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Mailbox scheduled for deletion", "schema": { "$ref": "#/definitions/responses.ScheduleMailboxesDeletionResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "patch": { "security": [ { "ApiKeyAuth": [] } ], "description": "Update mailbox details after creation, including profile picture and personal details", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Update mailbox", "parameters": [ { "type": "string", "description": "Mailbox ID", "name": "id", "in": "path", "required": true }, { "description": "Mailbox update payload", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.UpdateMailboxRequest" } } ], "responses": { "200": { "description": "Updated mailbox", "schema": { "$ref": "#/definitions/responses.MailboxResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/analytics/activity": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Headline tiles and the email activity chart for one mailbox", "produces": [ "application/json" ], "tags": [ "Analytics" ], "summary": "Get mailbox activity", "parameters": [ { "type": "string", "description": "Mailbox Id", "name": "id", "in": "path", "required": true }, { "type": "string", "default": "7d", "description": "One of 24h, 7d, 30d, 90d, 1y, all", "name": "period", "in": "query" } ], "responses": { "200": { "description": "Mailbox activity", "schema": { "$ref": "#/definitions/responses.MailboxActivityResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Mailbox not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/analytics/bounced-emails": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Bounce-back messages and the attributed bounce metrics for one mailbox", "produces": [ "application/json" ], "tags": [ "Analytics" ], "summary": "Get mailbox bounced emails", "parameters": [ { "type": "string", "description": "Mailbox Id", "name": "id", "in": "path", "required": true }, { "type": "string", "default": "7d", "description": "One of 24h, 7d, 30d, 90d, 1y, all", "name": "period", "in": "query" }, { "type": "integer", "default": 0, "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "integer", "default": 10, "description": "Rows per page, max 50", "name": "limit", "in": "query" }, { "type": "string", "description": "Filter by hard or soft", "name": "bounceType", "in": "query" } ], "responses": { "200": { "description": "Bounced emails", "schema": { "$ref": "#/definitions/responses.MailboxBouncedEmailsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Mailbox not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/analytics/recipients": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Recipient tiles, ESP breakdown, most contacted recipients and top recipient domains for one mailbox", "produces": [ "application/json" ], "tags": [ "Analytics" ], "summary": "Get mailbox recipients breakdown", "parameters": [ { "type": "string", "description": "Mailbox Id", "name": "id", "in": "path", "required": true }, { "type": "string", "default": "7d", "description": "One of 24h, 7d, 30d, 90d, 1y, all", "name": "period", "in": "query" }, { "type": "integer", "default": 0, "description": "Most contacted pagination offset", "name": "recipientsOffset", "in": "query" }, { "type": "integer", "default": 10, "description": "Most contacted rows per page, max 50", "name": "recipientsLimit", "in": "query" }, { "type": "integer", "default": 10, "description": "Top recipient domains to return, max 50", "name": "domainsLimit", "in": "query" } ], "responses": { "200": { "description": "Recipients breakdown", "schema": { "$ref": "#/definitions/responses.MailboxRecipientsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Mailbox not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/analytics/sending-ips": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "MTA IPs the mailbox relayed through, with reverse-DNS hostname and blacklist status", "produces": [ "application/json" ], "tags": [ "Analytics" ], "summary": "Get mailbox sending IP breakdown", "parameters": [ { "type": "string", "description": "Mailbox Id", "name": "id", "in": "path", "required": true }, { "type": "string", "default": "7d", "description": "One of 24h, 7d, 30d, 90d, 1y, all", "name": "period", "in": "query" }, { "type": "integer", "default": 0, "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "integer", "default": 10, "description": "Rows per page, max 50", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Sending IP breakdown", "schema": { "$ref": "#/definitions/responses.MailboxSendingIPsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Mailbox not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/cancel-deletion": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Cancel scheduled deletion for a single mailbox by its ID", "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Cancel scheduled mailbox deletion", "parameters": [ { "type": "string", "description": "Mailbox ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Scheduled deletion cancelled", "schema": { "$ref": "#/definitions/responses.CancelMailboxesDeletionResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/mailboxes/{id}/otp-code": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve the OTP code for a mailbox", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Mailboxes" ], "summary": "Get Mailbox OTP Code", "parameters": [ { "type": "string", "description": "mailbox Id", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "include soft-deleted mailbox", "name": "includeDeleted", "in": "query" } ], "responses": { "200": { "description": "OTP code", "schema": { "$ref": "#/definitions/responses.MailboxOtpCodeResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve all workspaces associated with the API Key account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "List Workspaces", "parameters": [ { "type": "integer", "description": "Pagination limit", "name": "limit", "in": "query" }, { "type": "integer", "description": "Pagination offset", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "List of workspaces", "schema": { "$ref": "#/definitions/responses.PaginatedResponse-responses_WorkspaceSimpleResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a new workspace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Create workspace", "parameters": [ { "description": "Workspace details", "name": "workspace", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateWorkspaceRequest" } } ], "responses": { "201": { "description": "Workspace created", "schema": { "$ref": "#/definitions/dto.CreateWorkspaceResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Retrieve specific workspace by its Id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Get Workspace by Id", "parameters": [ { "type": "string", "description": "workspace Id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Workspace details", "schema": { "$ref": "#/definitions/responses.WorkspaceSimpleResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "404": { "description": "Workspace not found", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Delete a workspace", "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Delete workspace", "parameters": [ { "type": "string", "description": "Workspace Id", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "Workspace deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces/{id}/exports": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Export mailboxes to a third-party platform. Supports multiple platforms including Salesforge, Warmforge, Instantly, Smartlead, EmailBison, Lemlist, Reply.io, Snov.io, Woodpecker, and Plusvibe. Some platforms may require additional fields like workspace, appUrl, or clientId.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Export Mailboxes to Platform", "parameters": [ { "type": "string", "description": "Workspace ID", "name": "id", "in": "path", "required": true }, { "description": "Export mailboxes request", "name": "exportRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PAExportMailboxesRequest" } } ], "responses": { "202": { "description": "Export initiated" }, "400": { "description": "Bad Request - Invalid platform or missing required fields", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces/{id}/exports/salesforge": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Export mailboxes to Salesforge platform", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Export Mailboxes to Salesforge", "parameters": [ { "description": "Export mailboxes request", "name": "exportRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PAAutoExportMailboxesRequest" } } ], "responses": { "202": { "description": "Export initiated" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces/{id}/exports/warmforge": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Export mailboxes to Warmforge platform", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Export Mailboxes to Warmforge", "parameters": [ { "description": "Export mailboxes request", "name": "exportRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/requests.PAAutoExportMailboxesRequest" } } ], "responses": { "202": { "description": "Export initiated" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } }, "/workspaces/{id}/mailboxes/analytics/summary": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Per-mailbox sent, received, reply rate and activity trend for every mailbox in the workspace", "produces": [ "application/json" ], "tags": [ "Analytics" ], "summary": "Get mailbox analytics summary", "parameters": [ { "type": "string", "description": "Workspace Id", "name": "id", "in": "path", "required": true }, { "type": "string", "default": "7d", "description": "One of 24h, 7d, 30d, 90d, 1y, all", "name": "period", "in": "query" }, { "type": "integer", "default": 1, "description": "Page of the mailbox list, 1-based", "name": "page", "in": "query" }, { "type": "integer", "default": 25, "description": "Mailboxes per page, 25 or 50", "name": "size", "in": "query" }, { "type": "string", "description": "Restrict to mailboxes matching this search", "name": "search", "in": "query" } ], "responses": { "200": { "description": "Analytics summary per mailbox", "schema": { "$ref": "#/definitions/responses.MailboxAnalyticsSummaryListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/errors.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/errors.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/errors.Error" } } } } } }, "definitions": { "dto.CreateWorkspaceRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 50, "minLength": 1 } } }, "dto.CreateWorkspaceResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "errors.Error": { "type": "object", "properties": { "data": {}, "message": { "type": "string" } } }, "httputils.OffsetPagination": { "type": "object", "properties": { "limit": { "description": "Limit for pagination", "type": "integer", "maximum": 100, "minimum": 1 }, "offset": { "description": "Offset for pagination", "type": "integer", "minimum": 0 } } }, "models.DNSRecordType": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "SRV", "NS", "PRT" ], "x-enum-varnames": [ "DNSRecordTypeA", "DNSRecordTypeAAAA", "DNSRecordTypeCNAME", "DNSRecordTypeMX", "DNSRecordTypeTXT", "DNSRecordTypeSRV", "DNSRecordTypeNS", "DNSRecordTypePRT" ] }, "models.DomainAutoRenewStatus": { "type": "string", "enum": [ "disabled", "enabled", "failed" ], "x-enum-varnames": [ "DomainAutoRenewStatusDisabled", "DomainAutoRenewStatusEnabled", "DomainAutoRenewStatusFailed" ] }, "models.DomainStatus": { "type": "string", "enum": [ "draft", "active", "pending", "transferring", "failed", "expired" ], "x-enum-comments": { "DomainStatusPending": "Purchased by user, but not purchased in Registrar yet" }, "x-enum-varnames": [ "DomainStatusDraft", "DomainStatusActive", "DomainStatusPending", "DomainStatusTransferring", "DomainStatusFailed", "DomainStatusExpired" ] }, "models.ForwardingStatus": { "type": "string", "enum": [ "pending", "active", "processing", "failed", "" ], "x-enum-varnames": [ "ForwardingStatusPending", "ForwardingStatusActive", "ForwardingStatusProcessing", "ForwardingStatusFailed", "ForwardingStatusNone" ] }, "models.MailboxStatus": { "type": "string", "enum": [ "draft", "active", "pending", "failed" ], "x-enum-varnames": [ "MailboxStatusDraft", "MailboxStatusActive", "MailboxStatusPending", "MailboxStatusFailed" ] }, "models.Platform": { "type": "string", "enum": [ "microsoft", "google" ], "x-enum-varnames": [ "PlatformMicrosoft", "PlatformGoogle" ] }, "models.SequencerPlatformName": { "type": "string", "enum": [ "salesforge", "warmforge", "instantly", "smartlead", "emailbison", "lemlist", "replyio", "snovio", "woodpecker", "plusvibe" ], "x-enum-varnames": [ "SequencerNameSalesforge", "SequencerNameWarmforge", "SequencerNameInstantly", "SequencerNameSmartLead", "SequencerNameEmailBison", "SequencerNameLemlist", "SequencerNameReplyIo", "SequencerNameSnovio", "SequencerNameWoodpecker", "SequencerNamePlusvibe" ] }, "requests.AddDNSRecordEARequest": { "type": "object", "required": [ "content", "name", "type" ], "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "ttl": { "description": "Time to live for the DNS record in seconds", "type": "integer" }, "type": { "$ref": "#/definitions/models.DNSRecordType" } } }, "requests.BuyDomainRequest": { "type": "object", "required": [ "domains", "platform", "workspaceId" ], "properties": { "contactDetails": { "type": "object", "required": [ "address1", "city", "country", "email", "firstName", "lastName", "phone", "postalCode", "province" ], "properties": { "address1": { "description": "Address line 1 for contact", "type": "string" }, "address2": { "type": "string" }, "city": { "description": "City for contact", "type": "string" }, "country": { "description": "Country for contact", "type": "string" }, "dmarcEmail": { "type": "string" }, "email": { "description": "Email address for domain registration", "type": "string" }, "firstName": { "description": "First name of the contact person", "type": "string" }, "forwardToDomain": { "type": "string" }, "jobTitle": { "type": "string" }, "lastName": { "description": "Last name of the contact person", "type": "string" }, "organization": { "type": "string" }, "phone": { "description": "Phone number for contact", "type": "string" }, "postalCode": { "description": "Postal code for contact", "type": "string" }, "province": { "description": "Province or state for contact", "type": "string" } } }, "domains": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "domain" ], "properties": { "domain": { "type": "string" }, "mailboxes": { "type": "array", "items": { "type": "object", "required": [ "firstName", "lastName", "username" ], "properties": { "firstName": { "description": "First name for the mailbox", "type": "string" }, "lastName": { "description": "Last name for the mailbox", "type": "string" }, "signature": { "type": "string" }, "username": { "description": "Username for the mailbox", "type": "string" } } } } } } }, "platform": { "enum": [ "google", "microsoft" ], "allOf": [ { "$ref": "#/definitions/models.Platform" } ] }, "workspaceId": { "description": "ID of the workspace to which the domain will be added", "type": "string" } } }, "requests.CreateMailboxForDomainRequest": { "type": "object", "required": [ "firstName", "lastName", "username" ], "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "signature": { "type": "string" }, "username": { "type": "string" } } }, "requests.CreateMailboxesForDomainRequest": { "type": "object", "required": [ "mailboxes", "workspaceId" ], "properties": { "mailboxes": { "type": "array", "items": { "$ref": "#/definitions/requests.CreateMailboxForDomainRequest" } }, "workspaceId": { "type": "string" } } }, "requests.ExternalAdjustTopupAmountRequest": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "description": "Mailbox topup amount in dollars", "type": "integer", "minimum": 10 } } }, "requests.ExternalBulkEnableDisableAutoRenewRequest": { "type": "object", "properties": { "domainIds": { "type": "array", "minItems": 1, "items": { "type": "string" } } } }, "requests.ExternalBulkUpdateDNSRequest": { "type": "object", "properties": { "cnameRecords": { "type": "array", "items": { "type": "object", "required": [ "address", "hostName", "type" ], "properties": { "address": { "type": "string", "example": "example.com" }, "hostName": { "type": "string", "example": "www" }, "type": { "type": "string", "example": "CNAME" } } } }, "dmarcEmail": { "type": "string", "example": "jondoedmarc@yahoo.com" }, "dmarcPolicy": { "type": "string", "enum": [ "none", "quarantine", "reject" ], "example": "none" }, "domains": { "description": "Domains is the list of domain IDs (e.g. \"dom_...\") to update. These must be\nIDs of domains that already exist (as returned by GET /domains), not domain names.", "type": "array", "minItems": 1, "items": { "type": "string" }, "example": [ "dom_abc123", "dom_def456" ] }, "forwardToDomain": { "type": "string", "example": "https://mydomain.com" } } }, "requests.ExternalSetDomainForwardingRequest": { "type": "object", "required": [ "domainIds" ], "properties": { "domainIds": { "type": "array", "minItems": 1, "items": { "type": "string" }, "example": [ "domain-123", "domain-456" ] }, "forwardingUrl": { "type": "string", "example": "https://example.com" } } }, "requests.ExternalTransferDomainsRequest": { "type": "object", "required": [ "workspaceId" ], "properties": { "dmarcEmail": { "type": "string", "example": "dmarc@example.com" }, "domains": { "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/requests.TransferDomainData" } }, "forwardToDomain": { "type": "string", "example": "https://example.com" }, "workspaceId": { "type": "string", "example": "wks_123" } } }, "requests.PAAutoExportMailboxesRequest": { "type": "object", "required": [ "email", "password", "workspaceSlug" ], "properties": { "email": { "type": "string" }, "excludedIds": { "type": "array", "items": { "type": "string" } }, "includedIds": { "type": "array", "items": { "type": "string" } }, "password": { "type": "string" }, "workspaceSlug": { "type": "string" } } }, "requests.GetMailboxesByAddressesRequest": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } }, "requests.GetMailboxesByIDsRequest": { "type": "object", "properties": { "mailboxIds": { "type": "array", "items": { "type": "string" } } } }, "requests.PublicGetMailboxesByAddressesRequest": { "type": "object", "required": ["addresses"], "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } }, "requests.PublicGetMailboxesByIDsRequest": { "type": "object", "required": ["mailboxIds"], "properties": { "mailboxIds": { "type": "array", "items": { "type": "string" } } } }, "requests.PAExportMailboxesRequest": { "type": "object", "required": [ "email", "password", "platform" ], "properties": { "appUrl": { "type": "string" }, "clientId": { "type": "string" }, "email": { "type": "string" }, "excludedIds": { "type": "array", "items": { "type": "string" } }, "includedIds": { "type": "array", "items": { "type": "string" } }, "password": { "type": "string" }, "platform": { "enum": [ "salesforge", "warmforge", "instantly", "smartlead", "emailbison", "lemlist", "replyio", "snovio", "woodpecker", "plusvibe" ], "allOf": [ { "$ref": "#/definitions/models.SequencerPlatformName" } ] }, "workspace": { "type": "string" } } }, "requests.PreWarmedDomain": { "type": "object", "required": [ "domain", "id", "mailboxes", "platform", "uid" ], "properties": { "domain": { "type": "string", "example": "example.com" }, "id": { "type": "string", "example": "id_1234567890" }, "mailboxes": { "type": "array", "minItems": 3, "items": { "$ref": "#/definitions/requests.PrewarmedMailbox" } }, "platform": { "type": "string", "enum": [ "GOOGLE", "MICROSOFT" ], "example": "GOOGLE" }, "uid": { "type": "string", "example": "uid_1234567890" } } }, "requests.PrewarmedMailbox": { "type": "object", "required": [ "email", "firstName", "lastName", "profilePicture", "uid", "username" ], "properties": { "email": { "type": "string", "example": "john.doe@example.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "profilePicture": { "type": "string", "example": "https://example.com/avatar.jpg" }, "uid": { "type": "string", "example": "uid_1234567890" }, "username": { "type": "string", "example": "john.doe" } } }, "requests.PurchasePreWarmedMailboxesRequest": { "type": "object", "required": [ "domains", "workspaceID" ], "properties": { "dmarcEmail": { "type": "string", "example": "dmarc@example.com" }, "domains": { "type": "array", "minItems": 4, "items": { "$ref": "#/definitions/requests.PreWarmedDomain" } }, "forwardToDomain": { "type": "string", "example": "https://example.com" }, "workspaceID": { "type": "string", "example": "ws_1234567890" } } }, "requests.TransferDomainData": { "type": "object", "required": [ "domain", "platform" ], "properties": { "domain": { "type": "string", "example": "example.com" }, "platform": { "allOf": [ { "$ref": "#/definitions/models.Platform" } ], "example": "google" } } }, "requests.UpdateDNSRecordEARequest": { "type": "object", "required": [ "content" ], "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "ttl": { "description": "Time to live for the DNS record in seconds", "type": "integer" }, "type": { "$ref": "#/definitions/models.DNSRecordType" } } }, "requests.UpdateMailboxRequest": { "type": "object", "properties": { "firstName": { "type": "string" }, "forwardingEmail": { "type": "string" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "signature": { "type": "string" }, "username": { "type": "string" } } }, "responses.AnalyticsPeriodResponse": { "description": "Period actually used to build the response", "type": "object", "properties": { "dataAvailableFrom": { "description": "Earliest timestamp the provider holds data for", "type": "string", "example": "2026-04-26T00:00:00Z" }, "days": { "description": "Number of days the period covers upstream", "type": "integer", "example": 7 }, "key": { "description": "Period key requested by the client", "type": "string", "example": "7d" } } }, "responses.BuyDomainResponse": { "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/definitions/responses.domainsBought" } }, "invoice": { "$ref": "#/definitions/responses.domainsBoughtInvoice" }, "setup": { "$ref": "#/definitions/responses.domainsBoughtSetup" } } }, "responses.CancelMailboxesDeletionResponse": { "description": "Response returned after cancelling scheduled mailbox deletion", "type": "object", "properties": { "cancelledCount": { "type": "integer", "example": 3 } } }, "responses.CreateMailboxesData": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } }, "responses.CreateMailboxesResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/responses.CreateMailboxesData" }, "message": { "type": "string" } } }, "responses.DetailedDomainResponse": { "type": "object", "properties": { "available": { "type": "boolean" }, "banned": { "type": "boolean" }, "google_workspace_available": { "type": "boolean" }, "is_premium": { "type": "boolean" }, "ms365_workspace_available": { "type": "boolean" }, "name": { "type": "string" }, "price": { "type": "number" } } }, "responses.DetailedDomainSearchResponse": { "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/definitions/responses.DetailedDomainResponse" } } } }, "responses.DomainDNSResponse": { "description": "DNS record response details", "type": "object", "properties": { "content": { "description": "Value/content of the DNS record", "type": "string", "example": "example.com" }, "editable": { "description": "Whether the DNS record is editable by the current account", "type": "boolean", "example": true }, "id": { "description": "Unique identifier of the DNS record", "type": "string", "example": "dns-123" }, "name": { "description": "Hostname of the DNS record", "type": "string", "example": "www" }, "type": { "description": "Type of DNS record (e.g., A, CNAME, MX)", "type": "string", "example": "CNAME" } } }, "responses.DomainResponse": { "description": "Domain information returned by the API", "type": "object", "properties": { "autoRenewFailedReason": { "description": "Auto renew failed reason", "type": "string", "example": "nameservers are incorrect" }, "autoRenewLastProcessedExpiration": { "description": "Auto renew last processed expiration", "type": "string", "example": "2021-01-01T00:00:00Z" }, "autoRenewProcessedAt": { "description": "Auto renew processed at", "type": "string", "example": "2021-01-01T00:00:00Z" }, "autoRenewStatus": { "description": "Auto renew status", "allOf": [ { "$ref": "#/definitions/models.DomainAutoRenewStatus" } ], "example": "enabled" }, "createdAt": { "description": "Creation timestamp", "type": "string", "example": "2026-01-01T00:00:00Z" }, "deletionScheduled": { "description": "Deletion scheduled", "type": "boolean", "example": false }, "expiresAt": { "description": "Expiration date of the domain", "type": "string", "example": "2021-01-01T00:00:00Z" }, "failedReason": { "description": "Reason for failure if domain setup failed", "type": "string", "example": "nameservers are incorrect" }, "forwardToDomain": { "description": "Domain to forward emails to", "type": "string", "example": "https://yourdomain.com" }, "id": { "description": "Unique identifier of the domain", "type": "string", "example": "domain-123" }, "platform": { "description": "Platform of the domain", "allOf": [ { "$ref": "#/definitions/models.Platform" } ], "example": "GOOGLE" }, "sld": { "description": "Second-level domain name", "type": "string", "example": "example" }, "status": { "description": "Current status of the domain", "allOf": [ { "$ref": "#/definitions/models.DomainStatus" } ], "example": "active" }, "tld": { "description": "Top-level domain name", "type": "string", "example": "com" }, "workspaceId": { "description": "Workspace the domain belongs to", "type": "string", "example": "wks_abc123" } } }, "responses.DomainTransferredNameserversResponse": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com" }, "expiresAt": { "type": "string", "example": "2026-01-01T00:00:00Z" }, "nameservers": { "type": "array", "items": { "type": "string" }, "example": [ "kai.ns.cloudflare.com", "pearl.ns.cloudflare.com" ] } } }, "responses.ExternalCheckDomainAvailabilityResponse": { "type": "object", "properties": { "available": { "type": "boolean", "example": true }, "domain": { "type": "string", "example": "example.com" }, "price": { "type": "number", "example": 14 } } }, "responses.MailboxActivityBucketResponse": { "description": "One daily bucket of the email activity chart", "type": "object", "properties": { "autoReplies": { "type": "integer", "example": 0 }, "bouncesHard": { "type": "integer", "example": 1 }, "bouncesSoft": { "type": "integer", "example": 0 }, "date": { "type": "string", "example": "2026-07-29" }, "received": { "type": "integer", "example": 254 }, "replies": { "type": "integer", "example": 61 }, "sent": { "type": "integer", "example": 21 }, "warmupReceived": { "type": "integer", "example": 463 }, "warmupSent": { "type": "integer", "example": 302 } } }, "responses.MailboxActivityChartResponse": { "description": "Email activity chart. Buckets are daily and UTC; roll them up client-side for longer windows. Bounce counts here are raw events, unlike the attributed figures in bounceDetails.", "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxActivityBucketResponse" } }, "series": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxActivitySeriesResponse" } }, "totalMessages": { "type": "integer", "example": 354 } } }, "responses.MailboxActivityDomainResponse": { "description": "Domain of the mailbox, so the page does not need a separate domains call.", "type": "object", "properties": { "name": { "type": "string", "example": "acceleratedfundsfinance.com" }, "platform": { "type": "string", "example": "google" }, "status": { "type": "string", "example": "active" } } }, "responses.MailboxActivityResponse": { "description": "Mailbox, its domain, headline tiles and email activity chart. Any section listed in degraded is zeroed.", "type": "object", "properties": { "degraded": { "type": "array", "items": { "type": "string" } }, "domain": { "$ref": "#/definitions/responses.MailboxActivityDomainResponse" }, "emailActivity": { "$ref": "#/definitions/responses.MailboxActivityChartResponse" }, "mailbox": { "$ref": "#/definitions/responses.MailboxResponse" }, "period": { "$ref": "#/definitions/responses.AnalyticsPeriodResponse" }, "tiles": { "$ref": "#/definitions/responses.MailboxActivityTilesResponse" } } }, "responses.MailboxActivitySeriesResponse": { "description": "One series of the email activity chart", "type": "object", "properties": { "key": { "type": "string", "example": "sent" }, "sharePct": { "type": "number", "example": 89.3 }, "total": { "type": "integer", "example": 316 } } }, "responses.MailboxActivityTilesResponse": { "description": "Headline metrics for the Activity and Health tab", "type": "object", "properties": { "bounceBacksReceived": { "type": "integer", "example": 3 }, "emailsReceived": { "type": "integer", "example": 125 }, "emailsSent": { "type": "integer", "example": 316 }, "firstTouchContacts": { "type": "integer", "example": 192 }, "replyRate": { "type": "number", "example": 12.5 } } }, "responses.MailboxAnalyticsSummaryListResponse": { "description": "Mailbox analytics summary for a batch of mailboxes", "type": "object", "properties": { "degraded": { "description": "Mailbox IDs whose analytics could not be loaded", "type": "array", "items": { "type": "string" } }, "mailboxes": { "description": "One entry per requested mailbox", "type": "array", "items": { "$ref": "#/definitions/responses.MailboxAnalyticsSummaryResponse" } }, "period": { "description": "Period actually used", "allOf": [ { "$ref": "#/definitions/responses.AnalyticsPeriodResponse" } ] } } }, "responses.MailboxAnalyticsSummaryResponse": { "description": "Per-mailbox analytics for the mailbox list page", "type": "object", "properties": { "healthStatus": { "description": "Health classification reported by the provider", "type": "string", "example": "healthy" }, "lastEventAt": { "description": "Timestamp of the most recent email event", "type": "string", "example": "2026-08-05T14:25:27Z" }, "mailboxId": { "description": "Unique identifier of the mailbox", "type": "string", "example": "mb_123456789" }, "received": { "description": "Regular emails received in the period", "type": "integer", "example": 125 }, "replyRate": { "description": "Replies as a percentage of non warm-up sends", "type": "number", "example": 12.5 }, "sent": { "description": "Non warm-up emails sent in the period", "type": "integer", "example": 316 }, "status": { "description": "Whether analytics could be loaded for this mailbox", "type": "string", "example": "ok" }, "trend": { "description": "Daily activity points for the sparkline", "type": "array", "items": { "$ref": "#/definitions/responses.MailboxTrendPointResponse" } } } }, "responses.MailboxBounceCauseResponse": { "description": "Bounce count grouped by cause", "type": "object", "properties": { "cause": { "type": "string", "example": "user_unknown" }, "count": { "type": "integer", "example": 33 } } }, "responses.MailboxBounceDetailsResponse": { "description": "Attributed bounce metrics and authentication pass rates", "type": "object", "properties": { "autoReplyCount": { "type": "integer", "example": 68 }, "autoReplyRate": { "type": "number", "example": 1.36 }, "bounceRate": { "type": "number", "example": 0.4 }, "causeBreakdown": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxBounceCauseResponse" } }, "dkimPassRate": { "type": "number", "example": 99.3 }, "dmarcPassRate": { "type": "number", "example": 99.15 }, "hardBounces": { "type": "integer", "example": 18 }, "orphanBounces": { "type": "integer", "example": 0 }, "softBounces": { "type": "integer", "example": 2 }, "spfPassRate": { "type": "number", "example": 99.28 }, "topBouncedDomains": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxBouncedDomainResponse" } }, "topBouncedRecipients": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxBouncedRecipientResponse" } }, "totalBounces": { "type": "integer", "example": 20 } } }, "responses.MailboxBouncedDomainResponse": { "description": "Recipient domain that bounced within the period", "type": "object", "properties": { "domain": { "type": "string", "example": "example.com" }, "hardBounces": { "type": "integer", "example": 7 }, "softBounces": { "type": "integer", "example": 0 }, "totalBounces": { "type": "integer", "example": 7 } } }, "responses.MailboxBouncedEmailResponse": { "description": "A bounce-back message, including the fields the detail modal shows", "type": "object", "properties": { "bodyText": { "type": "string" }, "bounceType": { "type": "string", "example": "hard" }, "cause": { "type": "string", "example": "user_unknown" }, "enhancedCode": { "type": "string", "example": "5.1.1" }, "failedRecipients": { "type": "array", "items": { "type": "string" } }, "messageId": { "type": "string", "example": "\u003cabc@mx.google.com\u003e" }, "receivedAt": { "type": "string", "example": "2026-08-04T20:49:16Z" }, "recipient": { "type": "string", "example": "unknown@example.com" }, "reportedBy": { "type": "string", "example": "mailer-daemon@googlemail.com" }, "reportingMta": { "type": "string" }, "smtpCode": { "type": "integer", "example": 550 }, "snippet": { "type": "string" }, "subject": { "type": "string", "example": "Delivery Status Notification (Failure)" } } }, "responses.MailboxBouncedEmailsListResponse": { "description": "Bounce-back list and the attributed bounce metrics. Any section listed in degraded is null.", "type": "object", "properties": { "bounceDetails": { "$ref": "#/definitions/responses.MailboxBounceDetailsResponse" }, "bouncedEmails": { "$ref": "#/definitions/responses.MailboxBouncedEmailsResponse" }, "degraded": { "type": "array", "items": { "type": "string" } }, "period": { "$ref": "#/definitions/responses.AnalyticsPeriodResponse" } } }, "responses.MailboxBouncedEmailsResponse": { "description": "Paginated bounce-back messages", "type": "object", "properties": { "pagination": { "$ref": "#/definitions/responses.OffsetPageResponse" }, "rows": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxBouncedEmailResponse" } } } }, "responses.MailboxBouncedRecipientResponse": { "description": "Recipient that bounced within the period", "type": "object", "properties": { "bounceCount": { "type": "integer", "example": 7 }, "email": { "type": "string", "example": "unknown@example.com" }, "hardBounces": { "type": "integer", "example": 7 }, "lastBounceAt": { "type": "string", "example": "2026-07-31T20:14:54Z" }, "softBounces": { "type": "integer", "example": 0 } } }, "responses.MailboxContactedResponse": { "description": "A recipient ranked by how often it was contacted", "type": "object", "properties": { "contacted": { "type": "integer", "example": 4 }, "contactedPct": { "type": "number", "example": 1.2 }, "email": { "type": "string", "example": "prospect@example.com" }, "lastSent": { "type": "string", "example": "2026-07-31T17:53:08Z" } } }, "responses.MailboxESPBreakdownResponse": { "description": "Recipient ESP breakdown. identifiedPct is the share of sends the provider could classify; the remainder lands in the unknown category.", "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxESPCategoryResponse" } }, "identifiedPct": { "type": "number", "example": 91 }, "replyRate": { "type": "number", "example": 12.2 }, "totalAutoReply": { "type": "integer", "example": 0 }, "totalDomains": { "type": "integer", "example": 141 }, "totalRecipients": { "type": "integer", "example": 301 }, "totalReplied": { "type": "integer", "example": 38 }, "totalSends": { "type": "integer", "example": 316 } } }, "responses.MailboxESPCategoryResponse": { "description": "Providers grouped by ESP category. Categories are raw provider keys: enterprise, smb, freemail, self_hosted, relay, unknown.", "type": "object", "properties": { "autoReplies": { "type": "integer", "example": 0 }, "category": { "type": "string", "example": "enterprise" }, "domains": { "type": "integer", "example": 85 }, "providers": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxESPProviderResponse" } }, "recipients": { "type": "integer", "example": 92 }, "replies": { "type": "integer", "example": 35 }, "replyRate": { "type": "number", "example": 35.9 }, "sends": { "type": "integer", "example": 92 }, "sharePct": { "type": "number", "example": 30.2 } } }, "responses.MailboxESPProviderResponse": { "description": "One email service provider within a category", "type": "object", "properties": { "autoReplies": { "type": "integer", "example": 0 }, "domains": { "type": "integer", "example": 40 }, "provider": { "type": "string", "example": "microsoft_365" }, "recipients": { "type": "integer", "example": 47 }, "replies": { "type": "integer", "example": 29 }, "replyRate": { "type": "number", "example": 61.7 }, "sampleDomain": { "type": "string", "example": "outlook.com" }, "sends": { "type": "integer", "example": 47 }, "sharePct": { "type": "number", "example": 15.4 } } }, "responses.MailboxGmailPlacementResponse": { "description": "Gmail placement split. Non-Gmail recipients count as unknown.", "type": "object", "properties": { "inbox": { "type": "integer", "example": 0 }, "promotions": { "type": "integer", "example": 0 }, "spam": { "type": "integer", "example": 0 }, "unknown": { "type": "integer", "example": 14510 } } }, "responses.MailboxMostContactedResponse": { "description": "Most contacted recipients. The provider ignores pagination on this endpoint, so a fixed window is fetched and paginated server-side; truncated reports that the mailbox has more recipients than that window holds.", "type": "object", "properties": { "pagination": { "$ref": "#/definitions/responses.OffsetPageResponse" }, "rows": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxContactedResponse" } }, "truncated": { "type": "boolean", "example": false } } }, "responses.MailboxOtpCodeResponse": { "type": "object", "properties": { "expiresAt": { "type": "integer" }, "otpCode": { "type": "string" } } }, "responses.MailboxRecipientDomainResponse": { "description": "A recipient domain ranked by emails sent to it", "type": "object", "properties": { "domain": { "type": "string", "example": "gmail.com" }, "lastSent": { "type": "string", "example": "2026-08-04T19:55:14Z" }, "sentTo": { "type": "integer", "example": 149 }, "sentToPct": { "type": "number", "example": 48.9 }, "uniqueRecipients": { "type": "integer", "example": 146 } } }, "responses.MailboxRecipientTilesResponse": { "description": "Headline metrics for the Recipients and Bounced tab", "type": "object", "properties": { "avgSendsPerProspect": { "type": "number", "example": 1 }, "recipientDomains": { "type": "integer", "example": 141 }, "sendsToProspects": { "type": "integer", "example": 305 }, "topDomain": { "type": "string", "example": "gmail.com" }, "topDomainSharePct": { "type": "number", "example": 48.9 }, "uniqueRecipients": { "type": "integer", "example": 301 } } }, "responses.MailboxRecipientsResponse": { "description": "Recipients and Bounced tab payload. Any section listed in degraded is null.", "type": "object", "properties": { "degraded": { "type": "array", "items": { "type": "string" } }, "espBreakdown": { "$ref": "#/definitions/responses.MailboxESPBreakdownResponse" }, "mostContacted": { "$ref": "#/definitions/responses.MailboxMostContactedResponse" }, "period": { "$ref": "#/definitions/responses.AnalyticsPeriodResponse" }, "tiles": { "$ref": "#/definitions/responses.MailboxRecipientTilesResponse" }, "topRecipientDomains": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxRecipientDomainResponse" } } } }, "responses.MailboxResponse": { "description": "Mailbox information returned by the API", "type": "object", "properties": { "address": { "description": "Address of the mailbox", "type": "string", "example": "john@useprimeforge.ai" }, "appPassword": { "description": "App password of the mailbox (Google only)", "type": "string", "example": "vcas gjks gnvs kgas" }, "createdAt": { "description": "Creation timestamp", "type": "string", "example": "2026-01-01T00:00:00Z" }, "deletionScheduled": { "description": "Whether mailbox deletion has been scheduled (status remains active until deleted)", "type": "boolean", "example": false }, "detailedStatus": { "description": "Detailed status of the mailbox", "type": "string", "example": "Provisioning mailbox" }, "domainId": { "description": "DomainID of the mailbox", "type": "string", "example": "dom_123456789" }, "firstName": { "description": "First name of the mailbox owner", "type": "string", "example": "John" }, "forwardingEmail": { "description": "Email address for forwarding", "type": "string", "example": "john@personal.com" }, "forwardingStatus": { "description": "Forwarding status of the mailbox", "allOf": [ { "$ref": "#/definitions/models.ForwardingStatus" } ], "example": "active" }, "id": { "description": "Unique identifier of the mailbox", "type": "string", "example": "mb_123456789" }, "isAdmin": { "description": "Whether the mailbox is an admin mailbox", "type": "boolean", "example": false }, "isPrewarmed": { "description": "Whether the mailbox was created via the attach-pre-warmed flow", "type": "boolean", "example": false }, "lastExportSequencer": { "description": "Last export sequencer/platform", "type": "string", "example": "salesforge" }, "lastExportStatus": { "description": "Last export status", "type": "string", "example": "completed" }, "lastExportTime": { "description": "Last export time", "type": "string", "example": "2026-01-01T00:00:00Z" }, "lastName": { "description": "Last name of the mailbox owner", "type": "string", "example": "Doe" }, "password": { "description": "Password of the mailbox", "type": "string", "example": "password123" }, "profilePictureUrl": { "description": "URL to the profile picture", "type": "string", "example": "https://example.com/profile.jpg" }, "signature": { "description": "Email signature", "type": "string", "example": "Best regards, John Doe" }, "status": { "description": "Status of the mailbox", "allOf": [ { "$ref": "#/definitions/models.MailboxStatus" } ], "example": "active" }, "username": { "description": "Username of the mailbox", "type": "string", "example": "john.doe" }, "validUntil": { "description": "Valid until date of the mailbox", "type": "string", "example": "2026-01-01T00:00:00Z" } } }, "responses.MailboxSendingIPRowResponse": { "description": "One MTA IP the mailbox relayed through", "type": "object", "properties": { "blacklistCheckedAt": { "type": "string", "example": "2026-08-05T09:26:00Z" }, "blacklistHits": { "type": "integer", "example": 0 }, "blacklistProviders": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string", "example": "2026-05-23T12:40:58Z" }, "gmailPlacement": { "$ref": "#/definitions/responses.MailboxGmailPlacementResponse" }, "hostname": { "type": "string", "example": "mta.example.com." }, "hostnameCheckedAt": { "type": "string", "example": "2026-08-01T15:37:32Z" }, "inboxRate": { "type": "number", "example": 92.5 }, "ip": { "type": "string", "example": "107.172.60.152" }, "lastSeenAt": { "type": "string", "example": "2026-08-05T14:25:27Z" }, "sent": { "type": "integer", "example": 71 } } }, "responses.MailboxSendingIPsListResponse": { "description": "Sending IP breakdown. sendingIps is null when the section is listed in degraded.", "type": "object", "properties": { "degraded": { "type": "array", "items": { "type": "string" } }, "period": { "$ref": "#/definitions/responses.AnalyticsPeriodResponse" }, "sendingIps": { "$ref": "#/definitions/responses.MailboxSendingIPsResponse" } } }, "responses.MailboxSendingIPsResponse": { "description": "Sending IP breakdown. Totals cover every IP the provider returns, not just the current page. When truncated is true the mailbox has more sending IPs than the provider will disclose, so the totals cover only the busiest 200 and the UI should caption them as such.", "type": "object", "properties": { "flaggedIps": { "type": "integer", "example": 19 }, "pagination": { "$ref": "#/definitions/responses.OffsetPageResponse" }, "rows": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxSendingIPRowResponse" } }, "totalSent": { "type": "integer", "example": 266 }, "truncated": { "type": "boolean", "example": false }, "uniqueIps": { "type": "integer", "example": 50 } } }, "responses.MailboxTrendPointResponse": { "description": "One point of a mailbox activity sparkline", "type": "object", "properties": { "date": { "description": "Day the point covers", "type": "string", "example": "2026-07-29" }, "received": { "description": "Regular emails received that day", "type": "integer", "example": 254 }, "sent": { "description": "Non warm-up emails sent that day", "type": "integer", "example": 21 } } }, "responses.OffsetPageResponse": { "description": "Offset pagination metadata", "type": "object", "properties": { "hasMore": { "type": "boolean", "example": true }, "limit": { "type": "integer", "example": 10 }, "offset": { "type": "integer", "example": 0 }, "total": { "type": "integer", "example": 271 } } }, "responses.PaginatedResponse-responses_DomainResponse": { "type": "object", "properties": { "pagination": { "$ref": "#/definitions/httputils.OffsetPagination" }, "results": { "type": "array", "items": { "$ref": "#/definitions/responses.DomainResponse" } }, "total": { "type": "integer" } } }, "responses.PaginatedResponse-responses_MailboxResponse": { "type": "object", "properties": { "pagination": { "$ref": "#/definitions/httputils.OffsetPagination" }, "results": { "type": "array", "items": { "$ref": "#/definitions/responses.MailboxResponse" } }, "total": { "type": "integer" } } }, "responses.PaginatedResponse-responses_WorkspaceSimpleResponse": { "type": "object", "properties": { "pagination": { "$ref": "#/definitions/httputils.OffsetPagination" }, "results": { "type": "array", "items": { "$ref": "#/definitions/responses.WorkspaceSimpleResponse" } }, "total": { "type": "integer" } } }, "responses.PreWarmedMailbox": { "type": "object", "properties": { "email": { "type": "string", "example": "john.doe@example.com" }, "firstName": { "type": "string", "example": "John" }, "id": { "type": "string", "example": "id_123" }, "isAdmin": { "type": "boolean", "example": false }, "lastName": { "type": "string", "example": "Doe" }, "profilePicture": { "type": "string", "example": "https://example.com/avatar.jpg" }, "uid": { "type": "string", "example": "uid_1234567890" }, "username": { "type": "string", "example": "john.doe" } } }, "responses.PreWarmedMailboxResponse": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com" }, "domainAgeDays": { "type": "integer", "example": 365 }, "id": { "type": "string", "example": "id_123" }, "mailboxes": { "type": "array", "items": { "$ref": "#/definitions/responses.PreWarmedMailbox" } }, "platform": { "type": "string", "example": "GOOGLE" }, "price": { "type": "number", "example": 14 }, "uid": { "type": "string", "example": "uid_1234567890" } } }, "responses.ScheduleMailboxesDeletionResponse": { "description": "Response returned after scheduling mailbox deletion", "type": "object", "properties": { "scheduledCount": { "type": "integer", "example": 3 } } }, "responses.WorkspaceSimpleResponse": { "type": "object", "properties": { "createdAt": { "type": "string", "example": "2021-08-01T00:00:00Z" }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "updatedAt": { "type": "string", "example": "2021-08-01T00:00:00Z" } } }, "responses.domainsBought": { "type": "object", "properties": { "createdAt": { "type": "string" }, "id": { "type": "string" }, "setupId": { "type": "string" }, "sld": { "type": "string" }, "tld": { "type": "string" }, "updatedAt": { "type": "string" } } }, "responses.domainsBoughtInvoice": { "type": "object", "properties": { "amountPaid": { "type": "integer" }, "creditsApplied": { "type": "integer" }, "id": { "type": "string" }, "paidAt": { "type": "string" }, "subTotal": { "type": "integer" }, "total": { "type": "integer" } } }, "responses.domainsBoughtSetup": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "dmarcEmail": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "forwardToDomain": { "type": "string" }, "id": { "type": "string" }, "jobTitle": { "type": "string" }, "lastName": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "province": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "workspaceId": { "type": "string" } } } }, "securityDefinitions": { "ApiKeyAuth": { "description": "API key for authentication. Format: \"{token}\"", "type": "apiKey", "name": "Authorization", "in": "header" } }, "tags": [ { "description": "Operations about domains", "name": "Domains" }, { "description": "Operations about mailboxes", "name": "Mailboxes" } ] }