Set forwarding

Points 1–25 domains at one URL. Send each domain as a separate array entry, not a comma-separated string. Valid requests wait for Cloudflare setup and retry temporary provider failures for up to 72 hours. A newer forwarding request supersedes an older pending target for the same domain. A destination matching any submitted domain or its www host is rejected. Rejected requests leave existing targets unchanged. 202 means the job was accepted, not that forwarding was applied. Poll the job or listen for domain.forwarding_* for its final result.

POST

domains

forwarding

Set forwarding

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/forwarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "trythekaizengrowthmarketing.com",
    "getthekaizengrowthmarketing.com"
  ],
  "forwarding_url": "https://kaizengrowthmarketing.com"
}
'

{
  "data": {
    "id": "fwj_01HZX0FW1A2B3C4D5E6F7G8H",
    "status": "completed",
    "completed_count": 3,
    "failed_count": 0,
    "forwarding_url": "https://acme.com",
    "completed": [
      "acme-mail.com",
      "team-acme.com",
      "news-acme.com"
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "not_connected_to_cloudflare"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:01:30Z"
  }
}

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

Body

application/json

domains

string[]

required

Each entry must be one dom_… ID or one raw domain name. Maximum 25 domains per call.

Required array length: 1 - 25 elements

Example:

[
  "trythekaizengrowthmarketing.com",
  "getthekaizengrowthmarketing.com"
]

forwarding_url

string

required

The full http(s) URL where the domains should redirect.

Example:

"https://kaizengrowthmarketing.com"

Response

Forwarding job started.

data

object

required

Show child attributes

Last modified on October 5, 2026

Set forwarding

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/forwarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "trythekaizengrowthmarketing.com",
    "getthekaizengrowthmarketing.com"
  ],
  "forwarding_url": "https://kaizengrowthmarketing.com"
}
'

{
  "data": {
    "id": "fwj_01HZX0FW1A2B3C4D5E6F7G8H",
    "status": "completed",
    "completed_count": 3,
    "failed_count": 0,
    "forwarding_url": "https://acme.com",
    "completed": [
      "acme-mail.com",
      "team-acme.com",
      "news-acme.com"
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "not_connected_to_cloudflare"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:01:30Z"
  }
}

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

Set forwarding

Authorizations

Body

Response