Create an order

Send an order to a connected workspace. Every destination includes its provider and Peeker workspace_id. For Smartlead, omit client_id to use the main workspace or include it to use that client workspace.

Orders do not accept Smartlead login credentials, customer data, or user data. A Smartlead Google order needs only the connected API key. Smartlead Microsoft or mixed orders use the optional login pair saved through POST /workspaces.

Use a bundle or custom sizing, never both. A normal order buys and provisions its own domains. It never reserves, attaches, or changes pre-warmed pool inventory. Only POST /pool/attach can do that. Bundle orders may send quantity. A quantity of 2 doubles the bundle domain and inbox counts; omitting it means 1. For a custom Google order, set google_licenses to 1, 2, or 3. Peeker creates that many Google inboxes on every submitted domain.

POST

orders

curl --request POST \
  --url https://api.peeker.ai/partner/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "destination": {
    "provider": "emailbison",
    "workspace_id": "wrk_01HZX0EB1A2B3C4D5E6F7G8H"
  },
  "order": {
    "microsoft_licenses": 1,
    "microsoft_inboxes_per_domain": 25,
    "domains": [
      "acme-mail.com"
    ],
    "personas": [
      {
        "first_name": "Alex",
        "last_name": "Rivera"
      }
    ]
  }
}
'

{
  "data": {
    "order": {
      "order_id": "ord_01HZX0QR1A2B3C4D5E6F7G8H",
      "status": "in_progress",
      "domain_count": 1,
      "costs": {
        "total_cents": 3000,
        "currency": "usd",
        "line_items": [
          {
            "type": "domain_registration",
            "quantity": 1,
            "amount_cents": 1300
          },
          {
            "type": "microsoft_license",
            "quantity": 1,
            "amount_cents": 1700
          }
        ]
      },
      "renews_at": null,
      "created_at": "2026-07-09T12:10:00.000Z"
    },
    "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
    "workspace_id": "wrk_01HZX0PV1A2B3C4D5E6F7G8H",
    "destination": {
      "provider": "plusvibe",
      "workspace_id": "wrk_01HZX0PV1A2B3C4D5E6F7G8H",
      "name": "Acme PlusVibe"
    },
    "created": {
      "order": true
    }
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

Authorizations

Authorization

string

header

default:Bearer pk_test_<your-test-key>

required

Partner API key (pk_live_… or pk_test_…).

Headers

Idempotency-Key

string

required

Required for order creation. Pool attach also supports this header for durable retries. Workspace creation does not use it. The value is unique across the Partner account. Reuse it only with the same endpoint and unchanged request body. When retrying an Instantly order after 422 provider_login_credentials_required, you may add or replace only destination.login_credentials; every other field must stay unchanged. For a Smartlead Microsoft or PlusVibe order with that error, repair the target through POST /workspaces, then retry the unchanged order with the same key. Retry 503 provider_unavailable or 500 internal_error with the same key and unchanged body. After pool attach returns 409 insufficient_inventory, wait for pool inventory to be replenished, then retry the unchanged body with the same key. After 422 provider_login_credentials_required or 422 provider_credentials_invalid, repair the target workspace, then retry the unchanged body with the same key.

Required string length: 1 - 256

Body

application/json

destination

object

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

order

Saved bundle sizing · object

required

Saved bundle sizing
Google licenses
Microsoft licenses

Show child attributes

Response

Order accepted, or the matching idempotent order returned.

data

object

required

Show child attributes

Last modified on August 25, 2026

curl --request POST \
  --url https://api.peeker.ai/partner/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "destination": {
    "provider": "emailbison",
    "workspace_id": "wrk_01HZX0EB1A2B3C4D5E6F7G8H"
  },
  "order": {
    "microsoft_licenses": 1,
    "microsoft_inboxes_per_domain": 25,
    "domains": [
      "acme-mail.com"
    ],
    "personas": [
      {
        "first_name": "Alex",
        "last_name": "Rivera"
      }
    ]
  }
}
'

{
  "data": {
    "order": {
      "order_id": "ord_01HZX0QR1A2B3C4D5E6F7G8H",
      "status": "in_progress",
      "domain_count": 1,
      "costs": {
        "total_cents": 3000,
        "currency": "usd",
        "line_items": [
          {
            "type": "domain_registration",
            "quantity": 1,
            "amount_cents": 1300
          },
          {
            "type": "microsoft_license",
            "quantity": 1,
            "amount_cents": 1700
          }
        ]
      },
      "renews_at": null,
      "created_at": "2026-07-09T12:10:00.000Z"
    },
    "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
    "workspace_id": "wrk_01HZX0PV1A2B3C4D5E6F7G8H",
    "destination": {
      "provider": "plusvibe",
      "workspace_id": "wrk_01HZX0PV1A2B3C4D5E6F7G8H",
      "name": "Acme PlusVibe"
    },
    "created": {
      "order": true
    }
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

Account

Provider workspaces

Bundles

Domains

Domain pool

Orders

Domain swaps

Create an order

Authorizations

Headers

Body

Response