Changing user names

Rename the First Name, Last Name, or email username (for example, name@domain.com -> fnamelname@domain.com) on an active order domain. The domain stays; only the inbox names change. Use this when the user’s names are wrong or need to be changed.

Each inbox address is derived from its persona’s names (for example, Jane + Doe becomes jane.doe@domain.com); you provide names, not addresses. profile_picture_url is accepted for forward compatibility but is not currently applied to inboxes.

POST

swaps

user_names

Changing user names

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"
      }
    ]
  }
}

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

domain_id

string

required

personas

object[]

required

New name list.

Show child attributes

Response

201 - application/json

Accepted user-name swaps.

data

object

required

Show child attributes

Last modified on June 16, 2026

Creating a domain swapReplace one domain with another inside an existing order. `standard` retires the old domain immediately. `premium` keeps the old domain warm for 14 days alongside the new one (Microsoft domains only; per-tier quota; 30-day cooldown per domain).

Changing user names

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"
      }
    ]
  }
}