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
      • Generate Sender Identities (MS Enterprise)
        POST
      • Place a DFY Order
        POST
      • Cancel a DFY Subscription
        POST
    • Email Account Automation
      • List automation rules
      • Create automation rule
      • Update automation rule
      • Delete automation rule
      • Get automation rule
      • Enable / disable automation rule
      • Duplicate automation rule
    • 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 every 60 seconds.

Fields used by both providers#

provider (required): GOOGLE_WORKSPACE or MS_ENTERPRISE
domains (required): the domains to order. Only .com domains are supported, max 50 per order.
senders (required): the identities behind the mailboxes. Each entry has first_name, last_name and prefixes - the mailbox names for that person (the part before the @). The mailboxes created are exactly the ones you list; nothing is added for you. Every prefix must be unique across all senders.
total_accounts (required): your explicit confirmation of how many email accounts this order creates - number of domains × total number of prefixes. If it does not match, nothing is charged and the expected number is returned.
forwarded_domain (optional): where visitors of the ordered domains are redirected.

GOOGLE_WORKSPACE#

Maximum 3 prefixes in total across all senders. So 3 senders with 1 prefix each, or 1 sender with 3 prefixes, are both valid.
mailbox_password (required): password for the created mailboxes - 8-25 characters with an uppercase letter, a digit and a special character; it must not contain any of the prefixes.
senders[].profile_picture_url (optional): that sender's own picture, used for their mailboxes.
master_inbox_email (optional): centralized master inbox for the created mailboxes.
Domains already running on Google Workspace cannot be ordered.

MS_ENTERPRISE#

Creates 99 email accounts per domain, so senders must carry exactly 99 prefixes in total. Use as many sender identities as you like and write the mailbox names yourself, or build the list with POST /dfy/generate-sender-identities and edit it as you wish.
mailbox_password, master_inbox_email and senders[].profile_picture_url are not supported for this provider and are rejected if sent.

Subscriptions created#

A successful order books TWO subscription entries - 1) the domain subscription and 2) the email accounts subscription. Both appear in GET /dfy/subscriptions, linked to each other via dfy_domain_subscription_id / dfy_email_subscription_id.

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 - the order was not placed and nothing was charged (validation error, a rule above not met, 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 - two subscription entries (domain + email) are booked, see GET /dfy/subscriptions. 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-raw '{
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "provider": "GOOGLE_WORKSPACE",
    "domains": [
        "acme-growth.com",
        "acme-reach.com"
    ],
    "senders": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "prefixes": [
                "john",
                "john.doe",
                "john.d"
            ],
            "profile_picture_url": "https://example.com/john.jpg"
        }
    ],
    "total_accounts": 6,
    "mailbox_password": "Str0ng!Pass1",
    "forwarded_domain": "acme.com",
    "master_inbox_email": "inbox@acme.com"
}'
Response Response Example
200 - Order placed
{
    "subscribed": true
}
Modified at 2026-07-29 08:02:36
Previous
Generate Sender Identities (MS Enterprise)
Next
Cancel a DFY Subscription
Built with