Import domains
Imports up to 25 customer-owned root domains and waits for the
result. Returns nameservers the customer may need to set before
ordering. For larger batches, use POST /domains/import/jobs.
POST
/
domains
/
import
Import domains
curl --request POST \
--url https://api.peeker.ai/partner/v1/domains/import \
--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
Partner API key (pk_live_… or pk_test_…).
Body
application/json
Maximum array length:
25Response
Import finished (success or per-domain failures surfaced in the job).
Show child attributes
Show child attributes
Last modified on August 25, 2026
⌘I
Import domains
curl --request POST \
--url https://api.peeker.ai/partner/v1/domains/import \
--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": {}
}
}