Import domains (async)

Queues an import for up to 500 customer-owned domains. Returns immediately with in_progress. Poll the job or listen for domain_import.* webhooks.

Retrying the same domain set returns the current non-failed job. If it is failed, submitting again creates a new attempt with a new job ID; the old job stays readable. Concurrent submissions share the new running attempt. For action_required, submit only the failed domains. No Idempotency-Key needed. Poll a known job ID to read status without starting another attempt after failure.

POST

domains

import

jobs

Import domains (async)

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "acme-mail.com",
    "team-acme.com"
  ]
}
'

{
  "data": {
    "id": "imp_01HZX0IM1A2B3C4D5E6F7G8H",
    "status": "in_progress",
    "submitted_count": 2,
    "completed_count": 0,
    "failed_count": 0,
    "nameserver_groups": [
      {
        "nameserver_one": "helena.ns.cloudflare.com",
        "nameserver_two": "idris.ns.cloudflare.com",
        "domains": [
          "acme-mail.com",
          "team-acme.com"
        ]
      }
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "cloudflare_import_failed"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:05:00Z"
  }
}

{
  "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_…).

Body

application/json

domains

string[]

required

Required array length: 1 - 500 elements

Response

Import job accepted.

data

object

required

Show child attributes

Last modified on October 5, 2026

Import domains (async)

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "acme-mail.com",
    "team-acme.com"
  ]
}
'

{
  "data": {
    "id": "imp_01HZX0IM1A2B3C4D5E6F7G8H",
    "status": "in_progress",
    "submitted_count": 2,
    "completed_count": 0,
    "failed_count": 0,
    "nameserver_groups": [
      {
        "nameserver_one": "helena.ns.cloudflare.com",
        "nameserver_two": "idris.ns.cloudflare.com",
        "domains": [
          "acme-mail.com",
          "team-acme.com"
        ]
      }
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "cloudflare_import_failed"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:05:00Z"
  }
}

{
  "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

Import domains (async)

Authorizations

Body

Response