Skip to main content
POST
/
domains
/
forwarding
Setting domain forwarding
curl --request POST \
  --url https://api.peeker.ai/api/partner/v1/domains/forwarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "<string>"
  ],
  "forwarding_url": "<string>"
}
'
{
  "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": "dns_lookup_failed"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:01:30Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Body

application/json
domains
string[]
required

Each entry can be a dom_… ID or a raw domain name.

forwarding_url
string
required

Where the domains should redirect to.

Response

202 - application/json

Forwarding job started.

data
object
required
Last modified on May 14, 2026