Set forwarding
Points up to 25 domains at one URL. Returns a job. Poll or listen
for domain.forwarding_* when it finishes.
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": [
"<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": "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": {}
}
}Authorizations
Partner API key (pk_live_… or pk_test_…).
Body
application/json
Response
Forwarding job started.
Show child attributes
Show child attributes
Last modified on August 24, 2026
⌘I
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": [
"<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": "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": {}
}
}