Peeker Partner API

POST

swaps

user_names

Rename inbox senders

curl --request POST \
  --url https://api.peeker.ai/partner/v1/swaps/user_names \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain_id": "<string>",
  "personas": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "profile_picture_url": "<string>"
    }
  ]
}
'

{
  "data": {
    "swaps": [
      {
        "id": "swp_01HZX0SW4A2B3C4D5E6F7G8H",
        "type": "user_names",
        "domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
        "replacement_domain": null,
        "status": "in_progress",
        "created_at": "2026-05-08T12:00: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": {}
  }
}

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

Headers

Idempotency-Key

string

Recommended for safe swap retries. Reuse the same key and request body after a timeout or server error. The original creation result is replayed, even after the swap has progressed. Keys are unique across the Partner account. Different parameters return 409 idempotency_conflict; an active request returns 409 idempotency_in_progress. Without a key, retries cannot recover the original creation response; check GET /swaps before resubmitting.

Required string length: 1 - 256

Body

application/json

domain_id

string

required

personas

object[]

required

New name list.

Show child attributes

Response

Accepted user-name swaps.

data

object

required

Show child attributes

Last modified on October 5, 2026

Rename inbox senders

curl --request POST \
  --url https://api.peeker.ai/partner/v1/swaps/user_names \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain_id": "<string>",
  "personas": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "profile_picture_url": "<string>"
    }
  ]
}
'

{
  "data": {
    "swaps": [
      {
        "id": "swp_01HZX0SW4A2B3C4D5E6F7G8H",
        "type": "user_names",
        "domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
        "replacement_domain": null,
        "status": "in_progress",
        "created_at": "2026-05-08T12:00: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": {}
  }
}

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

Rename inbox senders

Authorizations

Headers

Body

Response