1. DFY
Plusvibe.ai API Documentation
  • Getting Started
    • Getting Started
    • Webhooks - Overview
    • Webhooks - Payload - Email Replies
    • Webhooks - Payload - Lead Marked As Label
    • Webhooks - Payload - Campaign Emails Sent
    • Webhooks - Payload - Bounced Email
    • Webhooks - Payload - Unibox Email Sent
    • Webhooks - Payload - System Alert
    • Workspace Deep Link Parameter
  • User API Endpoints
    • Workspace
      • Get workspaces
      • Add a new workspace
      • Copy workspace settings
      • Invite a user to a workspace
    • Campaign
      • Create a new campaign
      • Create a new subsequence
      • List campaigns (deprecated)
      • List all campaigns
      • Get campaign name
      • Get campaign status
      • Get campaign email accounts
      • Get campaign emails
      • Get campaign variation stats
      • Set campaign name
      • Set campaign Schedules (deprecated)
      • Activate campaign
      • Pause campaign
      • Update Campaign
      • Delete or archive a campaign
    • Lead
      • Add leads to a campaign
      • Add leads to a subsequence campaign
      • Get or search for lead
      • Delete leads from a campaign
      • Lead Variable/Label Update or Add
      • Fetch workspace leads
      • Update the status of a lead
      • Get lead counts by status
    • Email Account
      • List all email accounts in the workspace
      • Get email account status
      • Check account vitals
      • Enable Email account warmup
      • Pause Email account warmup
      • Delete Email account
      • Get Warmup Stats (Workspace-Level)
      • Bulk Add SMTP Accounts
      • Bulk Update Email Accounts
      • Bulk Update Email Account Warmup Status
      • Bulk Assign/Remove Tags from Email Accounts
      • Bulk reconnect email accounts
      • Get email account stats for a date range
      • Move Email Accounts to Another Workspace
    • Analytics
      • Get campaign summary
      • Get campaign count (deprecated)
      • Get campaign stats
      • Get all campaigns statistics
    • Unibox
      • Get emails
      • Get emails in Others folder
      • Get count of unread emails
      • Reply to an email
      • Forward an existing email
      • Compose New Email
      • Mark Email Read
      • Send to any address
      • Save Email as Draft
      • Delete an Entire Email Thread
      • Delete a Single Email Message
    • Blocklist
      • Get entries in the blocklist
      • Adds entries to the blocklist
      • Delete entries in the blocklist
    • Webhook
      • Add a new webhook
      • List webhooks
      • Delete webhook(s)
    • Tags
      • List Tags
      • Create a New Tag
      • Update an Existing Tag
      • Delete Multiple Tags
    • Client Access
      • Create client
      • Edit client
      • Update client status
      • Delete client
      • List clients
    • Email Placement Test
      • Parent Recurring Test
        • Create a new parent test (recurring test)
        • Update a parent test
        • List all parent tests
        • Get parent test details
        • Delete parent test(s)
        • Duplicate a parent test
      • Child (Test Run) Test
        • List child (Test Run) tests
        • Get child test details
      • Results & Analytics
        • Get test summary
        • Get detailed test statistics
        • Get test result for a sender account
      • Get recipient providers
    • Workspace Additional Fields
      • List Additional Fields
      • Create Additional Field
      • Update Additional Field Default Value
      • Delete Additional Field
    • DFY
      • Search Domain Availability
        GET
      • List DFY Subscriptions
        GET
      • Place a DFY Order
        POST
      • Cancel a DFY Subscription
        POST
    • Schemas
      • ScheduleV2
      • Campaign
      • EmailAccountId
      • WarmupStatus
      • BulkUpdateWarmupRequest
      • TagAction
      • BulkTagAssignmentRequest
      • ObjectId
      • HexColor
      • CreateTagRequest
      • UpdateTagRequest
      • DeleteTagsRequest
      • DeleteCampaignRequest
      • BulkReconnectRequest
      • SuccessResponse
      • ErrorResponse
      • ClientWorkspacePermission
      • CreateClientRequest
      • CreateClientResponse
      • UpdateClientRequest
      • ClientListItem
      • PatchClientStatusRequest
      • GenericSuccessResponse
      • ParentTest
      • ParentTestDetail
      • ChildTest
      • ChildTestDetail
      • VariationStepStats
      • VariationStats
      • CopyWorkspaceRequest
      • ResourceType
      • CopyWorkspaceResponse
      • EmailStatsResponse
      • EmailStatsHeader
      • EmailStatsChartPoint
      • ValidationErrorResponse
      • CheckSuccess
      • AuthFailure
  • For Email Infra Provider
    • Email Infra Provider Guide
    • List workspaces
    • List all email accounts in the workspace
    • Check if an email exists in another workspace
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
    • Schemas
      • AuthFailure
      • CheckSuccess
      • ErrorResponse
  1. DFY

Place a DFY Order

POST
https://api.plusvibe.ai/api/v1/dfy/place-order
Places a DFY order: purchases the domains and creates ready-to-send email accounts on them, in a single order.
⚠️ Billing warning: this creates REAL recurring subscriptions charged to the organization's card on file. There is no dry-run mode. Only one order per organization can be submitted per 60 seconds.
Fields:
provider (required): GOOGLE_WORKSPACE or MS_ENTERPRISE
domains (required): the domains to order (max 100)
senders (required): the sender identities for the mailboxes - first_name, last_name, optional profile_picture_url, and (GOOGLE_WORKSPACE) optional prefixes (the part before the @). When prefixes is omitted, up to 3 are generated from the sender's name (e.g. john, john.doe, john.d). A maximum of 3 prefixes total per order.
total_accounts (required): explicit confirmation of how many email accounts the order creates. GOOGLE_WORKSPACE: domains × prefixes. MS_ENTERPRISE: domains × 99. If the number does not match, the order is rejected with the expected count and nothing is charged.
mailbox_password (GOOGLE_WORKSPACE only, required): password for the created mailboxes - 8-25 chars with an uppercase letter, a digit and a special character; must not contain a prefix.
usernames (MS_ENTERPRISE only, optional): exactly 99 username variations for the accounts; when omitted they are generated from the sender names.
master_inbox_email, forwarded_domain: optional.
MS_ENTERPRISE orders create 99 email accounts per domain.
Pre-checks (nothing is charged when they fail):
Domains already running on Google Workspace are rejected.
A mismatching total_accounts is rejected with the expected count.
Outcomes:
200 {"subscribed": true} - order placed. Track provisioning via GET /dfy/subscriptions.
200 {"subscribed": false, "message": ...} - payment succeeded but the domain purchase failed; the order is recorded and support is notified.
400 - validation error, pre-check failure, or the card on file could not be charged (complete the payment from the app in that case).

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Body Params application/json

Examples

Responses

🟢200OK
application/json
Order placed. subscribed: false means payment succeeded but the domain purchase failed (order recorded, support notified).
Bodyapplication/json

🟠400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.plusvibe.ai/api/v1/dfy/place-order' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "provider": "GOOGLE_WORKSPACE",
    "domains": [
        "acme-growth.com",
        "acme-reach.com"
    ],
    "senders": [
        {
            "first_name": "John",
            "last_name": "Doe"
        }
    ],
    "total_accounts": 6,
    "mailbox_password": "Str0ng!Pass1"
}'
Response Response Example
200 - Order placed
{
    "subscribed": true
}
Modified at 2026-07-28 11:47:45
Previous
List DFY Subscriptions
Next
Cancel a DFY Subscription
Built with